This is the repo for the Chi Hack Night Ghost Buses breakout group! If you're interested in working on it, you're invited to join the breakout group by attending Chi Hack Night.
Updated May 19, 2022
Currently, the AWS setup is based on this post with some references to the CPS Covid Dashboard back-end.
TODO: Describe how to make updates to the code in AWS
Set up a virtual environment with python3 -m venv .venv
and activate it with source .venv/bin/activate
(.venv\Scripts\activate
in Windows). Then run pip install -r requirements.txt
to install the required packages.
To set environment variables, create a .env
file in the top-level directory and add the following contents:
BUCKET_PUBLIC='chn-ghost-buses-public'
BUCKET_PRIVATE='chn-ghost-buses-private'
Note that there may be permissions issues when running rt_daily_aggregations.py
with BUCKET_PUBLIC
as the BUCKET_NAME
.
Pre-commit hooks are defined in .pre-commit-config.yaml
, based on this post. The hooks will enforce style with the linter black
, check for commited credentials and extraneous debugger breakpoints, and sort imports, among other things.
To get the latest versions of dependencies, update the .pre-commit-config.yaml
file with pre-commit autoupdate
. To run the hooks against all files without committing, use pre-commit run --all-files
. To have the pre-commit hooks run when executing git commit
, use pre-commit install
.