Skip to main content

a reusable private user messages application for Django with Django Rest Framework

Project description

Django Messages DRF

CircleCi codecov

Official Documentation - https://tarsil.github.io/django-messages-drf/


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(r"^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://tarsil.github.io/django-messages-drf/

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-messages-drf-1.0.6.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_messages_drf-1.0.6-py2.py3-none-any.whl (21.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-messages-drf-1.0.6.tar.gz.

File metadata

  • Download URL: django-messages-drf-1.0.6.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for django-messages-drf-1.0.6.tar.gz
Algorithm Hash digest
SHA256 4cb1c4dfed3f196a7cdc83f106b4d9816a30994851dfa1e5fc2b74e4f25c46d0
MD5 9de4c7d08ed26ccd0190326debc19a3b
BLAKE2b-256 945dc351573b0d77a54236428f1f54b5ff9e84b3c0815e40daa80037d7ca0387

See more details on using hashes here.

File details

Details for the file django_messages_drf-1.0.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_messages_drf-1.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 30297aa7116eb2bc5913ad29ce3974a0d7f157e05387ab43ec484df9b561f8ef
MD5 a42a2fbaaa5fe4c8d4910a4e5c5dfc6c
BLAKE2b-256 d1a4cf25b616562cfdb97294f29da3a3bffa6e9265aac8bc7d0df4de5f2531e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page