https://github.com/cds-snc/notification-utils

Notification Utils
https://github.com/cds-snc/notification-utils

alpha notification-canada-ca notify-core

Last synced: about 1 month ago
JSON representation

Notification Utils

• Host: GitHub
• URL: https://github.com/cds-snc/notification-utils
• Owner: cds-snc
• License: mit
• Created: 2019-07-04T16:04:09.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T22:07:51.000Z (8 months ago)
• Last Synced: 2024-04-23T14:15:02.718Z (8 months ago)
• Topics: alpha, notification-canada-ca, notify-core
• Language: Python
• Homepage:
• Size: 2.54 MB
• Stars: 3
• Watchers: 22
• Forks: 6
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Notification - notifications-utils [BETA]

Shared python code for Notification

Provides logging utils etc.

## Installing

This is a [python](https://www.python.org/) 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](https://python-poetry.org/).

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](http://pytest.org/latest/) is used for testing.

Running tests will also apply syntax checking, using [pycodestyle](https://pypi.python.org/pypi/pycodestyle).

Additionally code coverage is checked via pytest-cov:

## Documentation

* [How to work with notification-utils](https://github.com/cds-snc/notification-utils/wiki/How-to-work-with-notification-utils-locally)

* Documentation for the template used to render emails is in the [docs](./docs/README.md) folder.