RunasSudo/virtual-metro
Archived
1
Fork 0
Code Issues Pull Requests Activity

Add some basic documentation

Browse Source
This commit is contained in:
RunasSudo 2019-01-13 22:56:44 +11:00
parent 6f7f778312
commit e461314187
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -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
```

2
virtual_metro/config.example.py Normal file
View File

@ -0,0 +1,2 @@
PTV_USER_ID = '12345678'
PTV_API_KEY = '12345678-1234-1234-1234-1234567890ab'