Use this template as a way of creating your own Python API
- This uses docker-compose to run the API
- Specify any environments in a .env file and it will be loaded into the container
You will need to generate a new RSA, use the following command:
ssh-keygen -t rsa -b 4096
This will generate a public and private key. The following environment variables should be set with the values:
JWT_PUBLIC_KEY - public key
JWT_PRIVATE_KEY - private key
Start the server with docker compose
$ docker-compose up
Run tests using
$ pytest
See below for a list of environment variables:
| Name | Description | Type | Options | Default |
|---|---|---|---|---|
| DEBUG | Enable DEBUG mode on server | Bool | - True - False |
True |
| DB_HOST | Host to connect to for database | String | ||
| DB_PORT | Port for database connection | Integer | 27017 | |
| DB_USERNAME | Username for database connection | String | ||
| DB_PASSWORD | Password for database connection | String | ||
| AUTH_METHOD | Algorithm for signing JWTs | String | - HS256 | HS256 |
| AUTH_KEY | Secret for signing JWTs | String |