iNethi Backend

The backend for the bespoke iNethi system.

Commands

Prerequisites

Read the docs for details of the set up and requirements.

Running the Code

Look at .env.example and create a .env file with all the variables listed in this file. See the Notes section below for information on this process.

Dev

1. Create a .env file in the same folder as the docker compose file.
2. To run the code run docker compose -f docker-compose-dev.yml up or docker compose -f docker-compose-dev.yml up -d

Prod

1. Create a .env file in the same folder as the docker compose file.
2. To run the code run docker compose -f docker-compose-prod.yml up or docker compose -f docker-compose-prod.yml up -d

Testing

Ensure the DEV variable in the dev compose file is set to true: DEV=true.

• run flake8 in your docker container: docker compose -f docker-compose-dev.yml run --rm app sh -c "flake8"
• run unit tests in your docker container: docker compose -f docker-compose-dev.yml run --rm app sh -c "python manage.py test"

Notes

• if you want to run Django locally without docker, and you want to use psycopg2 you can either run pip install psycopg2-binary (not compiled for your OS so it is not recommended for deployment) else install the build dependencies for psycopg2. You can find them here or for Ubuntu run

sudo apt-get install python3-dev
sudo apt install gcc
sudo apt install build-essential
sudo apt install libpq-dev

then run pip install psycopg2 to install psycopg2.

• Generate your encryption key as follows:

from cryptography.fernet import Fernet
encryption_key = Fernet.generate_key()
print(f"Your encryption key: {encryption_key.decode()}")

• Generate your Django secret key as follows:

from django.core.management.utils import get_random_secret_key
print(get_random_secret_key())