A schedule app for Eastside Preparatory School, built with Google App Engine and Polymer.
EPSchedule is designed to be extremely easy to get running locally - all you need are git, Python 3.7+, and pip. To set it up, just run:
git clone https://github.com/guberti/epschedule.git
cd epschedule
pip install -r requirements.txt
You'll then need to get service account credentials to access sensitive user data, like schedules, photos, and crypto keys. Email Justin Uberti (justin@uberti.name) and we'll send you a file - epschedule-v2-xxxx.json - which should be renamed to service_account.json and put in your epschedule folder. Then, just run
python main.py
and navigate to http://localhost:8080/, where a local version of EPSchedule will be running!
We try to follow the Black Python and Google JavaScript style guides. To auto-format your Python code, run
black .
isort . --profile black
from the command line.
We use the pytest framework to test our Python code, and tests are run against all pull requests. To run the tests locally, simply run
pytest
from the command line.
From your fork of the epschedule repo, submit a pull request. Be sure that all tests pass, and you have followed the code style guides mentioned above.
To recrawl or manually adjust the master period schedule (master_schedule.json), follow the instructions at this link.
For more details, see the EPSchedule wiki.