Metadata-Version: 2.5
Name: django-sitemessage
Version: 1.4.1
Summary: Reusable application for Django introducing a message delivery framework
Project-URL: Homepage, https://github.com/idlesign/django-sitemessage
Project-URL: Documentation, https://django-sitemessage.readthedocs.io/
Author-email: Igor Starikov <idlesign@yandex.ru>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: Django,messaging,notifications
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: django-etc>=1.2.0
Description-Content-Type: text/markdown

# django-sitemessage

<https://github.com/idlesign/django-sitemessage>

[![release](https://img.shields.io/pypi/v/django-sitemessage.svg)](https://pypi.python.org/pypi/django-sitemessage)
[![lic](https://img.shields.io/pypi/l/django-sitemessage.svg)](https://pypi.python.org/pypi/django-sitemessage)
[![coverage](https://img.shields.io/coveralls/idlesign/django-sitemessage/master.svg)](https://coveralls.io/r/idlesign/django-sitemessage)

## Description

*Reusable application for Django introducing a message delivery framework.*

Features:

* **Message Types** — message classes exposing message composition logic (plain text, html, etc.).
* **Messengers** — clients for various protocols (smtp, jabber, twitter, telegram, facebook, vkontakte, etc.);
* Support for user defined message types.
* Support for user defined messenger types.
* Message prioritization.
* Message subscription/unsubscription system.
* Message grouping to prevent flooding.
* Message 'read' indication.
* Means for background message delivery and cleanup.
* Means to debug integration: test requisites, delivery log.
* Django Admin integration.

1. Configure messengers for your project (create `sitemessages.py` in one of your apps):

```python
from sitemessage.toolbox import register_messenger_objects, register_message_types
from sitemessage.messengers.smtp import SMTPMessenger

register_messenger_objects(
    # Here we register one messenger to deliver emails.
    # By default it uses mailing related settings from Django settings file.
    SMTPMessenger()
)
```

2. Schedule messages for delivery when and where needed (e.g. in a view):

```python
from sitemessage.shortcuts import schedule_email

def send_mail_view(request):
    ...

    # Suppose `user_model` is a recipient Django User model instance.
    user1_model = ...

    # We pass `request.user` into `sender` to keep track of senders.
    schedule_email('Message from sitemessage.', [user1_model, 'user2@host.com'], sender=request.user)

    ...
```

3. Periodically run Django management command from wherever you like (cli, cron, Celery, uWSGI, etc.):

    `./manage.py sitemessage_send_scheduled`

And that's only the tip of `sitemessage` iceberg, read the docs %)

## Documentation

<https://django-sitemessage.readthedocs.io/>
