The ClassClock API for storing and accessing schedule data
https://api.classclock.app
- Python 97.8%
- HTML 1.1%
- Mako 0.7%
- Dockerfile 0.4%
| .github/workflows | ||
| .vscode | ||
| blueprints | ||
| common | ||
| migrations | ||
| templates | ||
| .dockerignore | ||
| .gitignore | ||
| api.py | ||
| auth.py | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| createdb.py | ||
| Dockerfile | ||
| docs.py | ||
| fly.toml | ||
| LICENSE | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.md | ||
ClassClockAPI
This is the backend that provides access to the ClassClock database.
Environment Variables
| Environment Variable | Default | Purpose |
|---|---|---|
| DB_USERNAME | no default. this value is required | The username of the user to connect to the database with |
| DB_PASSWORD | no default. this value is required | The password of the user to connect to the database with |
| DB_HOST | localhost |
the hostname where the database is located |
| DB_NAME | classclock |
the name of the database to use if it is different |
| DB_CONNECTION_URL | constructed based on the above values | Allows the SQLAlchemy connection string to be manually set |
| AUTH0_DOMAIN | no default | The Auth0 api domain i.e. yourapp.auth0.com |
| API_IDENTIFIER | no default | Your Auth0 api identifier. This may be your API domain name. i.e. https://api.yourdomain.com |
| AUTH0_CLIENT_ID | no default | Your Auth0 Client ID |
| AUTH0_CLIENT_SECRET | no default | Your Auth0 Client Secret |
| SENTRY_DSN | no default | The dsn URL from the sentry.io setup in case you wish to set up error monitoring |
| TRUSTED_PROXY_COUNT | no default | The number of proxies that are in between users and the app itself. Setting this too high can create security problems. Setting too low can cause rate limiting to not work. see here for what this is used for |
First time Setup
- Prepare an empty database and have its configuration information handy (login, hostname/port, db name .etc)
- Install all dependencies (including dev dependencies) using
pipenv install -d - set up a
.envfile with your database configuration settings from earlier - create the db by running
pipenv run python3 createdb.py. add the--demoflag to createdb if you want to include demo data.
After this you should be ready to run the API.
Docker
This API has been set up to run in a docker container.
The simplest way to run it is to:
- aquire the container either from a docker repository or by running
docker build . -t classclock-apiin a cloned version of this repo - set up the environment variables you want per the above table
- use a command like
docker run -p 8000:8000 --rm -it --env-file dev.env classclock-api:latestto run the container interactively usingdev.envas the source of the environment variables. The app will start up on port 8000.
Contributing
If you are interested in making changes to the ClassClock API, see the CONTRIBUTING file for details on how to do so.