From a0c2e1f31f51faa17cb3654b124caee66d6e9931 Mon Sep 17 00:00:00 2001 From: Param Kapur Date: Mon, 27 May 2024 19:16:12 +0530 Subject: [PATCH] Rename SendInBlue ESP to Brevo (#5094) * Update cookiecutter.json with Brevo for SendInBlue * Change all occurrences of SendinBlue to Brevo --- README.md | 2 +- cookiecutter.json | 2 +- docs/project-generation-options.rst | 4 ++-- docs/settings.rst | 4 ++-- tests/test_cookiecutter_generation.py | 8 ++++---- .../.envs/.production/.django | 4 ++-- .../config/settings/production.py | 10 +++++----- .../requirements/production.txt | 4 ++-- 8 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6263c599..b73ecef9 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ Answer the prompts with your own desired [options](http://cookiecutter-django.re 4 - Mandrill 5 - Postmark 6 - Sendgrid - 7 - SendinBlue + 7 - Brevo (formerly SendinBlue) 8 - SparkPost 9 - Other SMTP Choose from 1, 2, 3, 4, 5, 6, 7, 8, 9 [1]: 1 diff --git a/cookiecutter.json b/cookiecutter.json index 4eeede9c..86e44f36 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -27,7 +27,7 @@ "Mandrill", "Postmark", "Sendgrid", - "SendinBlue", + "Brevo", "SparkPost", "Other SMTP" ], diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 23c8e917..21059d3a 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -91,7 +91,7 @@ mail_service: 4. Mandrill_ 5. Postmark_ 6. SendGrid_ - 7. SendinBlue_ + 7. `Brevo (formerly SendinBlue)`_ 8. SparkPost_ 9. `Other SMTP`_ @@ -174,7 +174,7 @@ debug: .. _Mandrill: http://mandrill.com .. _Postmark: https://postmarkapp.com .. _SendGrid: https://sendgrid.com -.. _SendinBlue: https://www.sendinblue.com +.. _Brevo (formerly SendinBlue): https://www.brevo.com .. _SparkPost: https://www.sparkpost.com .. _Other SMTP: https://anymail.readthedocs.io/en/stable/ diff --git a/docs/settings.rst b/docs/settings.rst index 0880bce9..2be79cbf 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -69,8 +69,8 @@ SENDGRID_API_KEY SENDGRID_API_KEY n/a SENDGRID_GENERATE_MESSAGE_ID True n/a raises error SENDGRID_MERGE_FIELD_FORMAT None n/a raises error SENDGRID_API_URL n/a n/a "https://api.sendgrid.com/v3/" -SENDINBLUE_API_KEY SENDINBLUE_API_KEY n/a raises error -SENDINBLUE_API_URL n/a n/a "https://api.sendinblue.com/v3/" +BREVO_API_KEY BREVO_API_KEY n/a raises error +BREVO_API_URL n/a n/a "https://api.brevo.com/v3/" SPARKPOST_API_KEY SPARKPOST_API_KEY n/a raises error SPARKPOST_API_URL n/a n/a "https://api.sparkpost.com/api/v1" ======================================= =========================== ============================================== ====================================================================== diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py index 141ae4cc..5a0bca38 100755 --- a/tests/test_cookiecutter_generation.py +++ b/tests/test_cookiecutter_generation.py @@ -73,7 +73,7 @@ SUPPORTED_COMBINATIONS = [ {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Mandrill"}, {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Postmark"}, {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Sendgrid"}, - {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "SendinBlue"}, + {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Brevo"}, {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "SparkPost"}, {"cloud_provider": "None", "use_whitenoise": "y", "mail_service": "Other SMTP"}, # Note: cloud_provider=None AND use_whitenoise=n is not supported @@ -83,7 +83,7 @@ SUPPORTED_COMBINATIONS = [ {"cloud_provider": "AWS", "mail_service": "Mandrill"}, {"cloud_provider": "AWS", "mail_service": "Postmark"}, {"cloud_provider": "AWS", "mail_service": "Sendgrid"}, - {"cloud_provider": "AWS", "mail_service": "SendinBlue"}, + {"cloud_provider": "AWS", "mail_service": "Brevo"}, {"cloud_provider": "AWS", "mail_service": "SparkPost"}, {"cloud_provider": "AWS", "mail_service": "Other SMTP"}, {"cloud_provider": "GCP", "mail_service": "Mailgun"}, @@ -91,7 +91,7 @@ SUPPORTED_COMBINATIONS = [ {"cloud_provider": "GCP", "mail_service": "Mandrill"}, {"cloud_provider": "GCP", "mail_service": "Postmark"}, {"cloud_provider": "GCP", "mail_service": "Sendgrid"}, - {"cloud_provider": "GCP", "mail_service": "SendinBlue"}, + {"cloud_provider": "GCP", "mail_service": "Brevo"}, {"cloud_provider": "GCP", "mail_service": "SparkPost"}, {"cloud_provider": "GCP", "mail_service": "Other SMTP"}, {"cloud_provider": "Azure", "mail_service": "Mailgun"}, @@ -99,7 +99,7 @@ SUPPORTED_COMBINATIONS = [ {"cloud_provider": "Azure", "mail_service": "Mandrill"}, {"cloud_provider": "Azure", "mail_service": "Postmark"}, {"cloud_provider": "Azure", "mail_service": "Sendgrid"}, - {"cloud_provider": "Azure", "mail_service": "SendinBlue"}, + {"cloud_provider": "Azure", "mail_service": "Brevo"}, {"cloud_provider": "Azure", "mail_service": "SparkPost"}, {"cloud_provider": "Azure", "mail_service": "Other SMTP"}, # Note: cloud_providers GCP, Azure, and None diff --git a/{{cookiecutter.project_slug}}/.envs/.production/.django b/{{cookiecutter.project_slug}}/.envs/.production/.django index ad652c9a..07ffd711 100644 --- a/{{cookiecutter.project_slug}}/.envs/.production/.django +++ b/{{cookiecutter.project_slug}}/.envs/.production/.django @@ -28,8 +28,8 @@ POSTMARK_SERVER_TOKEN= SENDGRID_API_KEY= SENDGRID_GENERATE_MESSAGE_ID=True SENDGRID_MERGE_FIELD_FORMAT=None -{% elif cookiecutter.mail_service == 'SendinBlue' %} -SENDINBLUE_API_KEY= +{% elif cookiecutter.mail_service == 'Brevo' %} +BREVO_API_KEY= {% elif cookiecutter.mail_service == 'SparkPost' %} SPARKPOST_API_KEY= {% endif %} diff --git a/{{cookiecutter.project_slug}}/config/settings/production.py b/{{cookiecutter.project_slug}}/config/settings/production.py index 2f5f0be8..5a6cbdb1 100644 --- a/{{cookiecutter.project_slug}}/config/settings/production.py +++ b/{{cookiecutter.project_slug}}/config/settings/production.py @@ -276,12 +276,12 @@ ANYMAIL = { "SENDGRID_API_KEY": env("SENDGRID_API_KEY"), "SENDGRID_API_URL": env("SENDGRID_API_URL", default="https://api.sendgrid.com/v3/"), } -{%- elif cookiecutter.mail_service == 'SendinBlue' %} -# https://anymail.readthedocs.io/en/stable/esps/sendinblue/ -EMAIL_BACKEND = "anymail.backends.sendinblue.EmailBackend" +{%- elif cookiecutter.mail_service == 'Brevo' %} +# https://anymail.readthedocs.io/en/stable/esps/brevo/ +EMAIL_BACKEND = "anymail.backends.brevo.EmailBackend" ANYMAIL = { - "SENDINBLUE_API_KEY": env("SENDINBLUE_API_KEY"), - "SENDINBLUE_API_URL": env("SENDINBLUE_API_URL", default="https://api.sendinblue.com/v3/"), + "BREVO_API_KEY": env("BREVO_API_KEY"), + "BREVO_API_URL": env("BREVO_API_URL", default="https://api.brevo.com/v3/"), } {%- elif cookiecutter.mail_service == 'SparkPost' %} # https://anymail.readthedocs.io/en/stable/esps/sparkpost/ diff --git a/{{cookiecutter.project_slug}}/requirements/production.txt b/{{cookiecutter.project_slug}}/requirements/production.txt index 8b79334d..e07d8382 100644 --- a/{{cookiecutter.project_slug}}/requirements/production.txt +++ b/{{cookiecutter.project_slug}}/requirements/production.txt @@ -35,8 +35,8 @@ django-anymail[mandrill]==10.3 # https://github.com/anymail/django-anymail django-anymail[postmark]==10.3 # https://github.com/anymail/django-anymail {%- elif cookiecutter.mail_service == 'Sendgrid' %} django-anymail[sendgrid]==10.3 # https://github.com/anymail/django-anymail -{%- elif cookiecutter.mail_service == 'SendinBlue' %} -django-anymail[sendinblue]==10.3 # https://github.com/anymail/django-anymail +{%- elif cookiecutter.mail_service == 'Brevo' %} +django-anymail[brevo]==10.3 # https://github.com/anymail/django-anymail {%- elif cookiecutter.mail_service == 'SparkPost' %} django-anymail[sparkpost]==10.3 # https://github.com/anymail/django-anymail {%- elif cookiecutter.mail_service == 'Other SMTP' %}