Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarsil/django-messages-drf
Simple messaging system for Django implementing Django Rest Framework
https://github.com/tarsil/django-messages-drf
django django-messages-drf django-rest-framework message-thread messages pinax-messages
Last synced: 2 months ago
JSON representation
Simple messaging system for Django implementing Django Rest Framework
- Host: GitHub
- URL: https://github.com/tarsil/django-messages-drf
- Owner: tarsil
- License: mit
- Created: 2020-08-18T15:49:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T17:47:35.000Z (over 1 year ago)
- Last Synced: 2024-10-03T07:58:12.881Z (3 months ago)
- Topics: django, django-messages-drf, django-rest-framework, message-thread, messages, pinax-messages
- Language: Python
- Homepage: https://tarsil.github.io/django-messages-drf/
- Size: 992 KB
- Stars: 21
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Django Messages DRF
[](https://circleci.com/gh/tarsil/django-messages-drf)
[](https://codecov.io/gh/tarsil/django-messages-drf)
**Official Documentation** -
---
## Table of Contents
- [Django Messages DRF](#django-messages-drf)
- [Table of Contents](#table-of-contents)
- [About Django Messages DRF](#about-django-messages-drf)
- [Overview](#overview)
- [Supported Django and Python Versions](#supported-django-and-python-versions)
- [Documentation](#documentation)
- [Installation](#installation)
- [Reference Guide](#reference-guide)
- [URL–View–Template Matrix](#urlviewtemplate-matrix)
- [Documentation and Support](#documentation-and-support)
- [License](#license)
---
## 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:
```shell
$ pip install django-messages-drf
```
Add `django_messages_drf` to your `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
# other apps
"django_messages_drf",
]
```
Run Django migrations to create `django-messages-drf` database tables:
```shell
$ python manage.py migrate
```
Add `django_messages_drf.urls` to your project urlpatterns:
```python
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
## License
Copyright (c) 2020-present Tiago Silva and contributors under the [MIT license](https://opensource.org/licenses/MIT).