diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba93a70 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Virtual Metro + +Online simulation of Melbourne Metro Trains (Public Transport Victoria) platform information display systems. + +![Example image](https://yingtongli.me/blog/assets/posts/2018/Clayton-Flinders.png) + +## Usage + +Apply for a [PTV Timetable API](https://www.ptv.vic.gov.au/about-ptv/data-and-reports/datasets/ptv-timetable-api/) API key, and copy *virtual_metro/config.example.py* to *virtual_metro/config.py* and set `PTV_USER_ID` and `PTV_USER_ID` accordingly. + +Create a Python virtual environment if necessary and install the required dependencies: + +```bash +virtualenv -p python3 venv +. venv/bin/activate +pip install -r requirements.txt +``` + +Run the app as per the [Flask documentation](http://flask.pocoo.org/docs/1.0/quickstart/): + +```bash +. venv/bin/activate +export FLASK_APP=virtual_metro +flask run +``` diff --git a/virtual_metro/config.example.py b/virtual_metro/config.example.py new file mode 100644 index 0000000..7406eec --- /dev/null +++ b/virtual_metro/config.example.py @@ -0,0 +1,2 @@ +PTV_USER_ID = '12345678' +PTV_API_KEY = '12345678-1234-1234-1234-1234567890ab'