Skip to content

cds-snc/notification-utils

Repository files navigation

Notification - notifications-utils [BETA]

Shared python code for Notification

Provides logging utils etc.

Installing

This is a python application.

Python version

This is a python 3 application. It has not been run against any version of python 2.x

brew install python3

Dependency management

This is done through poetry.

Setting up a virtualenvwrapper for python3

mkvirtualenv -p /usr/local/bin/python3 notifications-utils

The boostrap script will set the application up. Ensure you have activated the virtual environment first with poetry shell or prefix the command with poetry run

./scripts/bootstrap.sh

This will

  • Use poetry to install dependencies.

Tests

The ./scripts/run_tests.sh script will run all the tests. py.test is used for testing.

Running tests will also apply syntax checking, using pycodestyle.

Additionally code coverage is checked via pytest-cov:

Documentation