Metadata-Version: 2.1
Name: notifications-api-common
Version: 0.3.0
Summary: Re-usable integration layer for the Common Ground Notifications API specification.
Home-page: https://github.com/maykinmedia/notifications-api-common
Author: Maykin Media
Author-email: support@maykinmedia.nl
License: MIT
Project-URL: Changelog, https://github.com/maykinmedia/notifications-api-common/blob/main/CHANGELOG.rst
Project-URL: Bug Tracker, https://github.com/maykinmedia/notifications-api-common/issues
Project-URL: Source Code, https://github.com/maykinmedia/notifications-api-common
Keywords: notifications,REST,API,Common Ground,ZGW
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE
Requires-Dist: django>=4.2.0
Requires-Dist: django-solo
Requires-Dist: djangorestframework>=3.12.0
Requires-Dist: celery
Requires-Dist: djangorestframework_camel_case>=1.2.0
Requires-Dist: zgw-consumers>=0.35.1
Requires-Dist: ape-pie
Provides-Extra: db
Requires-Dist: psycopg2; extra == "db"
Provides-Extra: tests
Requires-Dist: psycopg2; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-django; extra == "tests"
Requires-Dist: freezegun; extra == "tests"
Requires-Dist: tox; extra == "tests"
Requires-Dist: isort; extra == "tests"
Requires-Dist: black; extra == "tests"
Requires-Dist: flake8; extra == "tests"
Requires-Dist: zgw-consumers[testutils]>=0.35.1; extra == "tests"
Provides-Extra: pep8
Requires-Dist: flake8; extra == "pep8"
Provides-Extra: coverage
Requires-Dist: pytest-cov; extra == "coverage"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: release
Requires-Dist: bumpversion; extra == "release"
Requires-Dist: twine; extra == "release"

notifications-api-common
========================

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

|build-status| |code-quality| |black| |coverage| |docs|

|python-versions| |django-versions| |pypi-version|

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

.. contents::

.. section-numbering::

Features
========

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

Installation
============

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


Install
-------

.. code-block:: bash

    pip install notifications-api-common


Usage
=====

See the `documentation <https://notifications-api-common.readthedocs.io/>`_.


.. |build-status| image:: https://github.com/maykinmedia/notifications-api-common/workflows/Run%20CI/badge.svg
    :alt: Build status
    :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Run+CI%22

.. |code-quality| image:: https://github.com/maykinmedia/notifications-api-common/workflows/Code%20quality%20checks/badge.svg
     :alt: Code quality checks
     :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Code+quality+checks%22

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |coverage| image:: https://codecov.io/gh/maykinmedia/notifications-api-common/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/maykinmedia/notifications-api-common
    :alt: Coverage status

.. |docs| image:: https://readthedocs.org/projects/notifications-api-common/badge/?version=latest
    :target: https://notifications-api-common.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/notifications-api-common.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/notifications-api-common.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/notifications-api-common.svg
    :target: https://pypi.org/project/notifications-api-common/
