Skip to content

department-of-veterans-affairs/notification-utils

 
 

Repository files navigation

notifications-utils

Shared Python 3 code for Notification to provide logging utilities, etc. It has not been run against any version of python 2.x

Installing Dependencies

Run these commands from the project's root directory to install and activate a virtual environment and to install Python dependencies, including dependencies for running unit tests.

  1. python3 -m venv venv/
  2. . venv/bin/activate
  3. ./scripts/bootstrap.sh

If you encounter an error about Wheel failing to build, ensure you have the Python3 development libraries installed on your machine. On Linux, this is the package libpython3-dev.

Unit Tests

The ./scripts/run_tests.sh script runs all unit tests using py.test and applies syntax checking using pycodestyle.

Versioning

With the virtual environment active, run python setup.py --version to see the current version on the current branch. Use git tag to add release tags to commits, and push the tags.

You can reference these release tags in requirements files in other repositories. See notification-api for an example.

E-mail Template Documentation

Documentation for the template used to render e-mails is in the docs folder.

Packages

No packages published

Languages

  • Python 97.2%
  • Jinja 2.6%
  • Shell 0.2%