tarsil / django-messages-drf

Simple messaging system for Django implementing Django Rest Framework
https://tarsil.github.io/django-messages-drf/
MIT License
22 stars 6 forks source link
django django-messages-drf django-rest-framework message-thread messages pinax-messages

Django Messages DRF

CircleCi codecov

Official Documentation - https://django-messages-drf.tarsild.io


Table of Contents


About Django Messages DRF

Django Messages DRF is an alternative and based on pinax-messages but using Django Rest Framework by making it easier to integrate with your existing project.

A special thanks to pinax for inspiring me to do this and use some ideas.

Overview

django-messages-drf is an app for providing private user-to-user threaded messaging.

Supported Django and Python Versions

Django / Python 3.6 3.7 3.8 3.9 3.10
2.2 Yes Yes Yes Yes Yes
3.0 Yes Yes Yes Yes Yes
3.1 Yes Yes Yes Yes Yes
3.2 Yes Yes Yes Yes Yes
4.0 Yes Yes Yes Yes Yes

Documentation

Installation

To install django-messages:

$ pip install django-messages-drf

Add django_messages_drf to your INSTALLED_APPS:

INSTALLED_APPS = [
    # other apps
    "django_messages_drf",
]

Run Django migrations to create django-messages-drf database tables:

$ python manage.py migrate

Add django_messages_drf.urls to your project urlpatterns:

    urlpatterns = [
        # other urls
        path("messages-drf/", include("django_messages_drf.urls", namespace="django_messages_drf")),
    ]

Reference Guide

URL–View–Template Matrix

URL Name View
django_messages_drf:inbox InboxListApiView
django_messages_drf:thread ThreadListApiView
django_messages_drf:thread-create ThreadCRUDApiView
django_messages_drf:thread-send ThreadCRUDApiView
django_messages_drf:thread-delete ThreadCRUDApiView
django_messages_drf:message-edit EditMessageApiView

Documentation and Support

Full documentation for the project is available at https://django-messages-drf.tarsild.io

License

Copyright (c) 2020-present Tiago Silva and contributors under the MIT license.