notifications-api-common


Namenotifications-api-common JSON
Version 0.8.1 PyPI version JSON
download
home_pagehttps://github.com/maykinmedia/notifications-api-common
SummaryRe-usable integration layer for the Common Ground Notifications API specification.
upload_time2025-07-23 09:23:30
maintainerNone
docs_urlNone
authorMaykin Media
requires_pythonNone
licenseMIT
keywords notifications rest api common ground zgw
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            notifications-api-common
========================

:Version: 0.8.1
: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/02/92/3d46bc80482855dcfdd5015c8e6e9c72bc0e7bd38948ab0a5d86a1a2c17d/notifications_api_common-0.8.1.tar.gz",
    "platform": null,
    "description": "notifications-api-common\n========================\n\n:Version: 0.8.1\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.1",
    "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": "fc7e7798a562265d04ddb5afa48fb663dfee225790b749b611817fee47842cc6",
                "md5": "472d565c9787f30b83f2df26d3ae10d6",
                "sha256": "62ec832704258b2e80cd87cd2bf0647d9a2bf7c336c4307ed3fd766a825b55b5"
            },
            "downloads": -1,
            "filename": "notifications_api_common-0.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "472d565c9787f30b83f2df26d3ae10d6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 43067,
            "upload_time": "2025-07-23T09:23:29",
            "upload_time_iso_8601": "2025-07-23T09:23:29.888236Z",
            "url": "https://files.pythonhosted.org/packages/fc/7e/7798a562265d04ddb5afa48fb663dfee225790b749b611817fee47842cc6/notifications_api_common-0.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "02923d46bc80482855dcfdd5015c8e6e9c72bc0e7bd38948ab0a5d86a1a2c17d",
                "md5": "fd5946b7528c6cb641ae3095911756cb",
                "sha256": "6ccbea6f48145d45b274b1af904fb39e18b9094e6d7ba538e37ce443f8846480"
            },
            "downloads": -1,
            "filename": "notifications_api_common-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "fd5946b7528c6cb641ae3095911756cb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 36078,
            "upload_time": "2025-07-23T09:23:30",
            "upload_time_iso_8601": "2025-07-23T09:23:30.787699Z",
            "url": "https://files.pythonhosted.org/packages/02/92/3d46bc80482855dcfdd5015c8e6e9c72bc0e7bd38948ab0a5d86a1a2c17d/notifications_api_common-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-23 09:23:30",
    "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"
}
        
Elapsed time: 1.39621s