Metadata-Version: 2.2
Name: drf-sendables
Version: 0.0.2
Summary: User messages for Django REST Framework
Home-page: https://github.com/amikrop/drf-sendables
Author: Aristotelis Mikropoulos
Author-email: amikrop@gmail.com
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: djangorestframework<3.16,>=3.10

drf-sendables
=============

User messages for Django REST Framework
---------------------------------------

.. image:: https://img.shields.io/pypi/v/drf-sendables.svg
   :target: https://pypi.org/project/drf-sendables/
   :alt: PyPI

.. image:: https://img.shields.io/pypi/pyversions/drf-sendables.svg
   :target: https://pypi.org/project/drf-sendables/
   :alt: PyPI - Python Version

.. image:: https://img.shields.io/pypi/l/drf-sendables.svg
   :target: https://pypi.org/project/drf-sendables/
   :alt: PyPI - License

.. image:: https://github.com/amikrop/drf-sendables/actions/workflows/main.yml/badge.svg
   :target: https://github.com/amikrop/drf-sendables/actions/
   :alt: Workflows

.. image:: https://readthedocs.org/projects/drf-sendables/badge/?version=latest
   :target: https://drf-sendables.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

*drf-sendables* is a `Django <https://www.djangoproject.com/>`_ reusable app providing the backend
for dispatching and managing in-site message-like entities. It can be plugged into a Django project,
utilizing any existing user authentication system. The HTTP REST API is implemented using
`Django REST framework <https://www.django-rest-framework.org/>`_.

Installation
------------

The following versions are supported:

    - Python: 3.10 - 3.12
    - Django: 3.0 - 5.0
    - Django REST Framework: 3.10 - 3.15

- Install via `pip <https://packaging.python.org/tutorials/installing-packages/>`_:

.. code-block:: bash

   $ pip install drf-sendables

- Add it to your ``INSTALLED_APPS``:

.. code-block:: python

   INSTALLED_APPS = [
       # ...
       "sendables",
   ]

- Register the app's URLs under a path of your choice:

.. code-block:: python

   urlpatterns = [
       # ...
       path("some-path/", include("sendables.urls")),
   ]

where ``"some-path/"`` could be any URL.

- Optionally, configure the app `settings <https://drf-sendables.readthedocs.io/en/latest/settings.html>`_.

- Generate and run the database migrations:

.. code-block:: bash

   $ python manage.py makemigrations sendables
   $ python manage.py migrate

Usage
-----

You can find the description of the app's `endpoints <https://drf-sendables.readthedocs.io/en/latest/api.html#endpoints>`_
in the `documentation <https://drf-sendables.readthedocs.io/en/latest/>`_. For customized usage, see the relevant
`page <https://drf-sendables.readthedocs.io/en/latest/custom.html>`_.

License
-------

Distributed under the `MIT License <https://github.com/amikrop/drf-sendables/blob/master/LICENSE>`_.
