/ozi

Mailings management microservice for Tomoru.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Ozi

Build Status codecov CodeFactor Requirements Status

Mailings management microservice for Tomoru.

Installation

Install dependencies using pip:

pip install -r requirements.txt

or Poetry:

poetry install

Poetry will install dev-dependencies as well. So use that if you are planning to contribute.

Setup

  1. SECRET_KEY. You might want to use something like Djecrety or Python's secrets module to generate a secret key.
  2. DEBUG. A boolean value. Defaults to False.

Usage

Run the server:

gunicorn config.wsgi

and run task processing:

python manage.py process_tasks

You might want to activate shell first with:

poetry shell

Tests

Run tests using pytest:

pytest --cov=.

Notes

Note that for the build to be successful it has to have no flake8 errors and have >= 90% test coverage.

License

GNU GPLv3