{"id":15017619,"url":"https://github.com/idlesign/django-sitemessage","last_synced_at":"2025-04-12T12:32:01.758Z","repository":{"id":17944063,"uuid":"20924309","full_name":"idlesign/django-sitemessage","owner":"idlesign","description":"Reusable application for Django introducing a message delivery framework","archived":false,"fork":false,"pushed_at":"2023-03-18T13:00:17.000Z","size":536,"stargazers_count":55,"open_issues_count":0,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-26T07:21:32.912Z","etag":null,"topics":["django","messaging","python","smtp","telegram","twitter","vkontakte","xmpp"],"latest_commit_sha":null,"homepage":"https://github.com/idlesign/django-sitemessage","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/idlesign.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-17T13:28:18.000Z","updated_at":"2025-03-08T04:09:25.000Z","dependencies_parsed_at":"2022-08-27T16:24:52.632Z","dependency_job_id":null,"html_url":"https://github.com/idlesign/django-sitemessage","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idlesign%2Fdjango-sitemessage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idlesign%2Fdjango-sitemessage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idlesign%2Fdjango-sitemessage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idlesign%2Fdjango-sitemessage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/idlesign","download_url":"https://codeload.github.com/idlesign/django-sitemessage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248566572,"owners_count":21125690,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","messaging","python","smtp","telegram","twitter","vkontakte","xmpp"],"created_at":"2024-09-24T19:50:45.889Z","updated_at":"2025-04-12T12:32:00.633Z","avatar_url":"https://github.com/idlesign.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"django-sitemessage\n==================\nhttps://github.com/idlesign/django-sitemessage\n\n.. image:: https://img.shields.io/pypi/v/django-sitemessage.svg\n    :target: https://pypi.python.org/pypi/django-sitemessage\n\n.. image:: https://img.shields.io/pypi/l/django-sitemessage.svg\n    :target: https://pypi.python.org/pypi/django-sitemessage\n\n.. image:: https://img.shields.io/coveralls/idlesign/django-sitemessage/master.svg\n    :target: https://coveralls.io/r/idlesign/django-sitemessage\n\nDescription\n-----------\n\n*Reusable application for Django introducing a message delivery framework.*\n\nFeatures:\n\n* **Message Types** - message classes exposing message composition logic (plain text, html, etc.).\n* **Messengers** - clients for various protocols (smtp, jabber, twitter, telegram, facebook, vkontakte, etc.);\n* Support for user defined message types.\n* Support for user defined messenger types.\n* Message prioritization.\n* Message subscription/unsubscription system.\n* Message grouping to prevent flooding.\n* Message 'read' indication.\n* Means for background message delivery and cleanup.\n* Means to debug integration: test requisites, delivery log.\n* Django Admin integration.\n\n\n1. Configure messengers for your project (create ``sitemessages.py`` in one of your apps):\n\n.. code-block:: python\n\n    from sitemessage.toolbox import register_messenger_objects, register_message_types\n    from sitemessage.messengers.smtp import SMTPMessenger\n\n    register_messenger_objects(\n        # Here we register one messenger to deliver emails.\n        # By default it uses mailing related settings from Django settings file.\n        SMTPMessenger()\n    )\n\n\n2. Schedule messages for delivery when and where needed (e.g. in a view):\n\n.. code-block:: python\n\n    from sitemessage.shortcuts import schedule_email\n\n    def send_mail_view(request):\n        ...\n\n        # Suppose `user_model` is a recipient Django User model instance.\n        user1_model = ...\n\n        # We pass `request.user` into `sender` to keep track of senders.\n        schedule_email('Message from sitemessage.', [user1_model, 'user2@host.com'], sender=request.user)\n\n        ...\n\n\n3. Periodically run Django management command from wherever you like (cli, cron, Celery, uWSGI, etc.):\n\n    ./manage.py sitemessage_send_scheduled\n\n\nAnd that's only the tip of ``sitemessage`` iceberg, read the docs %)\n\n\nDocumentation\n-------------\n\nhttp://django-sitemessage.readthedocs.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidlesign%2Fdjango-sitemessage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidlesign%2Fdjango-sitemessage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidlesign%2Fdjango-sitemessage/lists"}