notifications-api-common
========================
:Version: 0.2.2
:Source: https://github.com/maykinmedia/notifications-api-common
:Keywords: notifications, REST, API, Common Ground, ZGW
:PythonVersion: 3.9
|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.7 or above
* setuptools 30.3.0 or above
* Django 3.2 or newer
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/
Raw data
{
"_id": null,
"home_page": "https://github.com/maykinmedia/notifications-api-common",
"name": "notifications-api-common",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "notifications,REST,API,Common Ground,ZGW",
"author": "Maykin Media",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/c2/40/d2f3649a76fd0c4d35e26b7762f861ac4d1e2d2e5e28586f87ab13e6f91a/notifications-api-common-0.2.2.tar.gz",
"platform": null,
"description": "notifications-api-common\n========================\n\n:Version: 0.2.2\n:Source: https://github.com/maykinmedia/notifications-api-common\n:Keywords: notifications, REST, API, Common Ground, ZGW\n:PythonVersion: 3.9\n\n|build-status| |code-quality| |black| |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.7 or above\n* setuptools 30.3.0 or above\n* Django 3.2 or newer\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.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\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.2.2",
"split_keywords": [
"notifications",
"rest",
"api",
"common ground",
"zgw"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9f887a1b4166838b1aa6be2d244238d21830609a3c94b74005ecd13601cf737",
"md5": "828f3e08e8e4ef2683d24b9dc99e791b",
"sha256": "810a37380df7423bab7d5df940062849bc01534de3568ebb1cd1d9b53b67edda"
},
"downloads": -1,
"filename": "notifications_api_common-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "828f3e08e8e4ef2683d24b9dc99e791b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 34529,
"upload_time": "2023-04-20T10:44:48",
"upload_time_iso_8601": "2023-04-20T10:44:48.179226Z",
"url": "https://files.pythonhosted.org/packages/d9/f8/87a1b4166838b1aa6be2d244238d21830609a3c94b74005ecd13601cf737/notifications_api_common-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c240d2f3649a76fd0c4d35e26b7762f861ac4d1e2d2e5e28586f87ab13e6f91a",
"md5": "17db8273da6f4f04178fbf7aa5632695",
"sha256": "d5d315f74007230cc4be3392d0940bf226d437ea1b6c972a8ea10fc8f54e1fce"
},
"downloads": -1,
"filename": "notifications-api-common-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "17db8273da6f4f04178fbf7aa5632695",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24040,
"upload_time": "2023-04-20T10:44:49",
"upload_time_iso_8601": "2023-04-20T10:44:49.943677Z",
"url": "https://files.pythonhosted.org/packages/c2/40/d2f3649a76fd0c4d35e26b7762f861ac4d1e2d2e5e28586f87ab13e6f91a/notifications-api-common-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 10:44:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "maykinmedia",
"github_project": "notifications-api-common",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "notifications-api-common"
}
JSON
