Skip to content

edwardhorsford/notifications-utils

 
 

Repository files navigation

GOV.UK Notify - notifications-utils [BETA]

Shared python code for GOV.UK Notify

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 pip and virtualenv. In practise we have used VirtualEnvWrapper for our virtual environemnts.

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.

`./scripts/bootstrap.sh`

This will

  • Use pip 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

Documentation for the template used to render emails is in the docs folder.

About

Shared code between GOV.UK Notify applications

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 95.7%
  • HTML 3.3%
  • Other 1.0%