README.md

Notify API

BC Registries notify services.

Development Environment

Following the instructions of the Development Readme to setup your local development environment.

Development Setup

1. Follow the instructions to checkout the project from GitHub.
2. Open the notify-api directory in VS Code to treat it as a project (or WSL projec). To prevent version clashes, set up a virtual environment to install the Python packages used by this project.
3. Run make setup to set up the virtual environment and install libraries.
4. Next run pip install . to set up the environment for running tests.

You also need to set up the variables used for environment-specific settings:

1. Copy the dotenv template file to somewhere above the source code and rename to .env. You will need to fill in missing values.

Running the Notify Database on localhost

To prepare your local database:

1. In the root project folder: docker-compose up -d
2. In your venv environment: alembic db upgrade

Running NOTIFY-API

1. Start the flask server with (uvicorn main:app --reload --port 5000)
2. View the OpenAPI Docs.

Running Liniting

1. Run make flake8 or flake8 src/auth_api tests.
2. Run make pylint or pylint --rcfile=setup.cfg --disable=C0301,W0511 src/auth_api test

Running Unit Tests

1. Tests are run from the Status bar at the bottom of the workbench in VS Code or pytest command.
2. Next run make coverage to generate the coverage report, which appears in the htmlcov directory.

Openshift Environment

View the document.