From 823605303299a6978da1998e9fdc7e15b23f4bad Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Mon, 15 Jan 2018 14:02:39 +0100 Subject: [PATCH] Update doc, drop config --- README.md | 23 ++++++++++++++--------- config.py.example | 7 ------- velib.py | 2 -- 3 files changed, 14 insertions(+), 18 deletions(-) delete mode 100644 config.py.example diff --git a/README.md b/README.md index 8fbaca7..0448298 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,27 @@ VelibDataSet ============ This code can be used to dump periodically all the available data from the -Velib API, the bike sharing system in Paris. The data are under an OpenData -license. +Velib API, the bike sharing system in Paris. + +It is basically a wrapper around [pybikes](https://github.com/eskerda/pybikes) +to dump values periodically in a SQLite database. + ## Usage * Clone this repo. -* Create an account to access the velib API: https://developer.jcdecaux.com/#/home. -* Copy `config.py.example` to `config.py` and set your API key there. -* Run `velib.py`. +* Install [pybikes](https://github.com/eskerda/pybikes). +* Run `python2 velib.py`. + +_Note:_ For now, `pybikes` is only Python2 compatible. ## Dumped data +**Important:** For the latest information about the dump available at +https://pub.phyks.me/datasets/velib/, please refer to +https://pub.phyks.me/datasets/velib/README.txt. + This script is used to dump the returned data from the Velib API every few minutes. Dumps are available at https://pub.phyks.me/datasets/velib/. @@ -57,11 +65,8 @@ cat *.png | ffmpeg -f image2pipe -framerate 10 -i - output.mp4 ## Links -* Velib API: https://developer.jcdecaux.com/#/home -* Velib website: http://velib.paris/ +* Velib website: http://velib-metropole.fr/ ## License -Data is under [an Open Data license](https://developer.jcdecaux.com/#/opendata/license). - Code is released under MIT license. diff --git a/config.py.example b/config.py.example deleted file mode 100644 index 7ce8222..0000000 --- a/config.py.example +++ /dev/null @@ -1,7 +0,0 @@ -# Global common endpoints -api_endpoint = "https://api.jcdecaux.com/vls/v1/stations" - -# Configuration -debug = True -api_key = "SET_YOUR_API_KEY_HERE" -contract = "Paris" diff --git a/velib.py b/velib.py index 5f32968..6830b39 100755 --- a/velib.py +++ b/velib.py @@ -1,6 +1,4 @@ #!/usr/bin/env python3 -from config import * - import datetime import json import os