# Django Azure Communication Email
[](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml)
[](https://badge.fury.io/py/django-azure-communication-email)
[](https://img.shields.io/badge/python-3.8+-blue)
[](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.13,>=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/65/81/fea90b2c89691c2b15e4493b591e21db8294227157fc8259a0f74ef780e8/django_azure_communication_email-1.1.0.tar.gz",
"platform": null,
"description": "# Django Azure Communication Email\n\n[](https://github.com/rebotics/django-azure-communication-email/actions/workflows/ci.yml)\n[](https://badge.fury.io/py/django-azure-communication-email)\n[](https://img.shields.io/badge/python-3.8+-blue)\n[](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.1.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": "39815962ab94a5130ad57ecd46db6f0bf36a135fe84e3e4138d6bf0eac83306b",
"md5": "3f27f367bbe0c166f106a0f056dc2fbd",
"sha256": "a6154a561e6d9c85b0ccb1db05f93fb456582b284bdee5f594c29547411ca9d3"
},
"downloads": -1,
"filename": "django_azure_communication_email-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f27f367bbe0c166f106a0f056dc2fbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 10490,
"upload_time": "2024-04-06T22:49:09",
"upload_time_iso_8601": "2024-04-06T22:49:09.919518Z",
"url": "https://files.pythonhosted.org/packages/39/81/5962ab94a5130ad57ecd46db6f0bf36a135fe84e3e4138d6bf0eac83306b/django_azure_communication_email-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6581fea90b2c89691c2b15e4493b591e21db8294227157fc8259a0f74ef780e8",
"md5": "bc118b0d24f5a95a060a0c6a5e7a9e83",
"sha256": "74b8c829e5d090e652769a9ea6f3d34be27c4a76f71326ea472db912e14f95e2"
},
"downloads": -1,
"filename": "django_azure_communication_email-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bc118b0d24f5a95a060a0c6a5e7a9e83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 8930,
"upload_time": "2024-04-06T22:49:10",
"upload_time_iso_8601": "2024-04-06T22:49:10.906039Z",
"url": "https://files.pythonhosted.org/packages/65/81/fea90b2c89691c2b15e4493b591e21db8294227157fc8259a0f74ef780e8/django_azure_communication_email-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 22:49:10",
"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"
}
JSON
