notifications-api-common
========================
:Version: 0.8.0
:Source: https://github.com/maykinmedia/notifications-api-common
:Keywords: notifications, REST, API, Common Ground, ZGW
:PythonVersion: 3.12
|build-status| |code-quality| |ruff| |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
.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff
.. |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/
Raw data
{
"_id": null,
"home_page": "https://github.com/maykinmedia/notifications-api-common",
"name": "notifications-api-common",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "notifications, REST, API, Common Ground, ZGW",
"author": "Maykin Media",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/b4/da/812315d0ec37ae6cca544b840e7bb079786683614d6272b8c30cd544890d/notifications_api_common-0.8.0.tar.gz",
"platform": null,
"description": "notifications-api-common\n========================\n\n:Version: 0.8.0\n:Source: https://github.com/maykinmedia/notifications-api-common\n:Keywords: notifications, REST, API, Common Ground, ZGW\n:PythonVersion: 3.12\n\n|build-status| |code-quality| |ruff| |coverage| |docs|\n\n|python-versions| |django-versions| |pypi-version|\n\nRe-usable integration layer for the Common Ground Notifications API specification.\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* Define your own notifications channels\n* Easily emit notifications from your API endpoints (using DRF)\n* Manage subscriptions to receive notifications\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.10 or above\n* setuptools 30.3.0 or above\n* Django 4.2 or newer\n* Celery 5.0 or newer setup with one worker deployed\n\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install notifications-api-common\n\n\nUsage\n=====\n\nSee the `documentation <https://notifications-api-common.readthedocs.io/>`_.\n\n\n.. |build-status| image:: https://github.com/maykinmedia/notifications-api-common/workflows/Run%20CI/badge.svg\n :alt: Build status\n :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Run+CI%22\n\n.. |code-quality| image:: https://github.com/maykinmedia/notifications-api-common/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/maykinmedia/notifications-api-common/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n \n.. |coverage| image:: https://codecov.io/gh/maykinmedia/notifications-api-common/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/notifications-api-common\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/notifications-api-common/badge/?version=latest\n :target: https://notifications-api-common.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/notifications-api-common.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/notifications-api-common.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/notifications-api-common.svg\n :target: https://pypi.org/project/notifications-api-common/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Re-usable integration layer for the Common Ground Notifications API specification.",
"version": "0.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/notifications-api-common/issues",
"Changelog": "https://github.com/maykinmedia/notifications-api-common/blob/main/CHANGELOG.rst",
"Homepage": "https://github.com/maykinmedia/notifications-api-common",
"Source Code": "https://github.com/maykinmedia/notifications-api-common"
},
"split_keywords": [
"notifications",
" rest",
" api",
" common ground",
" zgw"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6f175b5daaf6bf64b2b0b82cf659739f7bc2e17e1575212b0b4a9853db77ff69",
"md5": "e7966fe79ff1aa3a074762d2902c9ac7",
"sha256": "1f63797ea3c7c44be5c45d4d8ad8c2075539de08c70ebe1f4010193ecb2e6bc2"
},
"downloads": -1,
"filename": "notifications_api_common-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7966fe79ff1aa3a074762d2902c9ac7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 43024,
"upload_time": "2025-07-08T09:52:51",
"upload_time_iso_8601": "2025-07-08T09:52:51.073837Z",
"url": "https://files.pythonhosted.org/packages/6f/17/5b5daaf6bf64b2b0b82cf659739f7bc2e17e1575212b0b4a9853db77ff69/notifications_api_common-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b4da812315d0ec37ae6cca544b840e7bb079786683614d6272b8c30cd544890d",
"md5": "43b9e8e288afff301f38f9a631f16122",
"sha256": "de797be4171da49f84afd96477972cbd5221ffc35f94e40a0331d1517f9dc90d"
},
"downloads": -1,
"filename": "notifications_api_common-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "43b9e8e288afff301f38f9a631f16122",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35887,
"upload_time": "2025-07-08T09:52:51",
"upload_time_iso_8601": "2025-07-08T09:52:51.991325Z",
"url": "https://files.pythonhosted.org/packages/b4/da/812315d0ec37ae6cca544b840e7bb079786683614d6272b8c30cd544890d/notifications_api_common-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 09:52:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "notifications-api-common",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "notifications-api-common"
}
JSON
