django-azure-communication-email


Namedjango-azure-communication-email JSON
Version 1.3.0 PyPI version JSON
download
home_pagehttps://github.com/retech-us/django-azure-communication-email
SummaryA Django email backend for Azure Communication Email service.
upload_time2024-12-12 12:57:25
maintainerNone
docs_urlNone
authorDmitrii Azarenko
requires_python<3.14,>=3.8
licenseApache-2.0
keywords django email azure
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Django Azure Communication Email

[![Unit tests](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/django-azure-communication-email.svg)](https://badge.fury.io/py/django-azure-communication-email)
[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://img.shields.io/badge/python-3.8+-blue)
[![Django](https://img.shields.io/badge/django-2.2+-blue.svg)](https://img.shields.io/badge/django-2.2+-blue)

A Django email backend for Azure Communication Email service.


## Installation
Run the following on your system:

    pip install django-azure-communication-email

Then, add these settings to your Django `settings.py`:

    EMAIL_BACKEND = 'django_azure_communication_email.EmailBackend'

    AZURE_COMMUNICATION_CONNECTION_STRING = '...'
    # OR
    AZURE_KEY_CREDENTIAL = '...'
    AZURE_COMMUNICATION_ENDPOINT = '...'

If you prefer to use Azure Active Directory authentication, you can use the
following `settings.py` instead:

    EMAIL_BACKEND = 'django_azure_communication_email.EmailBackend'
    
    AZURE_COMMUNICATION_ENDPOINT = '...'
    
    # Note: make sure to set the following environment variables:
    # AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET

Now, when you use `django.core.mail.send_mail`, Azure Communication Email
service will send the messages by default.

## Running Tests
To run the tests::

    python runtests.py

If you want to debug the tests, just add this file as a python script to your IDE run configuration.

## Creating a Release

To create a release:

* Run `poetry version {patch|minor|major}` as explained in [the docs](https://python-poetry.org/docs/cli/#version).
  This will update the version in `pyproject.toml`.
* Commit that change and use git to tag that commit with a version that matches the pattern `v*.*.*`.
* Push the tag and the commit (note some IDEs don't push tags by default).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/retech-us/django-azure-communication-email",
    "name": "django-azure-communication-email",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.8",
    "maintainer_email": null,
    "keywords": "django, email, azure",
    "author": "Dmitrii Azarenko",
    "author_email": "dmitrii.azarenko@symphonyai.com",
    "download_url": "https://files.pythonhosted.org/packages/7d/3d/daa1c1b252e8624dfce97a758b44cd9a8724fe75fa9383aa69b8932138ae/django_azure_communication_email-1.3.0.tar.gz",
    "platform": null,
    "description": "# Django Azure Communication Email\n\n[![Unit tests](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml)\n[![PyPI version](https://badge.fury.io/py/django-azure-communication-email.svg)](https://badge.fury.io/py/django-azure-communication-email)\n[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://img.shields.io/badge/python-3.8+-blue)\n[![Django](https://img.shields.io/badge/django-2.2+-blue.svg)](https://img.shields.io/badge/django-2.2+-blue)\n\nA Django email backend for Azure Communication Email service.\n\n\n## Installation\nRun the following on your system:\n\n    pip install django-azure-communication-email\n\nThen, add these settings to your Django `settings.py`:\n\n    EMAIL_BACKEND = 'django_azure_communication_email.EmailBackend'\n\n    AZURE_COMMUNICATION_CONNECTION_STRING = '...'\n    # OR\n    AZURE_KEY_CREDENTIAL = '...'\n    AZURE_COMMUNICATION_ENDPOINT = '...'\n\nIf you prefer to use Azure Active Directory authentication, you can use the\nfollowing `settings.py` instead:\n\n    EMAIL_BACKEND = 'django_azure_communication_email.EmailBackend'\n    \n    AZURE_COMMUNICATION_ENDPOINT = '...'\n    \n    # Note: make sure to set the following environment variables:\n    # AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET\n\nNow, when you use `django.core.mail.send_mail`, Azure Communication Email\nservice will send the messages by default.\n\n## Running Tests\nTo run the tests::\n\n    python runtests.py\n\nIf you want to debug the tests, just add this file as a python script to your IDE run configuration.\n\n## Creating a Release\n\nTo create a release:\n\n* Run `poetry version {patch|minor|major}` as explained in [the docs](https://python-poetry.org/docs/cli/#version).\n  This will update the version in `pyproject.toml`.\n* Commit that change and use git to tag that commit with a version that matches the pattern `v*.*.*`.\n* Push the tag and the commit (note some IDEs don't push tags by default).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A Django email backend for Azure Communication Email service.",
    "version": "1.3.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/retech-us/django-azure-communication-email/issues",
        "Company Website": "https://retechlabs.com",
        "Homepage": "https://github.com/retech-us/django-azure-communication-email",
        "Repository": "https://github.com/retech-us/django-azure-communication-email"
    },
    "split_keywords": [
        "django",
        " email",
        " azure"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ca1758059850880c50c626667ebf5fdbb521865dcf9f507557482b82708bd383",
                "md5": "ad9b7688aba314f34c5364b8cd7cb9fc",
                "sha256": "69339e27197a126621bc11e031848464b1e6c6de92936931a8bbe7caa5e8db89"
            },
            "downloads": -1,
            "filename": "django_azure_communication_email-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad9b7688aba314f34c5364b8cd7cb9fc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.8",
            "size": 10493,
            "upload_time": "2024-12-12T12:57:24",
            "upload_time_iso_8601": "2024-12-12T12:57:24.585174Z",
            "url": "https://files.pythonhosted.org/packages/ca/17/58059850880c50c626667ebf5fdbb521865dcf9f507557482b82708bd383/django_azure_communication_email-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d3ddaa1c1b252e8624dfce97a758b44cd9a8724fe75fa9383aa69b8932138ae",
                "md5": "b4074d3ee895dbf57d3f061f35e21da3",
                "sha256": "4874952e1565157c4de173c03bfef7594b256e2fd9c4c6035cbdb2db39b7c6fe"
            },
            "downloads": -1,
            "filename": "django_azure_communication_email-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b4074d3ee895dbf57d3f061f35e21da3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.8",
            "size": 8938,
            "upload_time": "2024-12-12T12:57:25",
            "upload_time_iso_8601": "2024-12-12T12:57:25.684388Z",
            "url": "https://files.pythonhosted.org/packages/7d/3d/daa1c1b252e8624dfce97a758b44cd9a8724fe75fa9383aa69b8932138ae/django_azure_communication_email-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-12 12:57:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "retech-us",
    "github_project": "django-azure-communication-email",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "django-azure-communication-email"
}
        
Elapsed time: 0.43998s