README.rst

1   notifications-api-common

Version:	0.5.0
Source:	https://github.com/maykinmedia/notifications-api-common
Keywords:	notifications, REST, API, Common Ground, ZGW
PythonVersion:	3.10

Re-usable integration layer for the Common Ground Notifications API specification.

Contents

• 1   notifications-api-common
• 2   Features
• 3   Installation
  • 3.1   Requirements
  • 3.2   Install
• 4   Usage

2   Features

• Define your own notifications channels
• Easily emit notifications from your API endpoints (using DRF)
• Manage subscriptions to receive notifications

3   Installation

3.1   Requirements

• Python 3.10 or above
• setuptools 30.3.0 or above
• Django 4.2 or newer
• Celery 5.0 or newer setup with one worker deployed

3.2   Install

pip install notifications-api-common

4   Usage

See the documentation.