README.rst

drf-sendables

User messages for Django REST Framework

drf-sendables is a Django 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.

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:

$ pip install drf-sendables

• Add it to your INSTALLED_APPS:

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

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

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

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

• Optionally, configure the app settings.
• Generate and run the database migrations:

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

Usage

You can find the description of the app's endpoints in the documentation. For customized usage, see the relevant page.

License

Distributed under the MIT License.