Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Brevo: Rename SendinBlue to Brevo #364

Merged
merged 2 commits into from
Mar 12, 2024
Merged

Brevo: Rename SendinBlue to Brevo #364

merged 2 commits into from
Mar 12, 2024

Conversation

medmunds
Copy link
Contributor

I've been rethinking my arguments in #321 about leaving "SendinBlue" in the code while calling it "Brevo" everywhere else. I now feel this creates more confusion (particularly with new users) than it avoids.

This PR renames "sendinblue" to "brevo" throughout the code, but maintains compatibility versions on the old names and URLs (with deprecation warnings).

The compatibility versions use the old esp_name, which means that settings names and other related features are also unchanged. So if you have EMAIL_BACKEND = "…⁠sendinblue.EmailBackend", Anymail will continue to look for SENDINBLUE_API_KEY in the settings. But when you update to EMAIL_BACKEND = "…⁠brevo.EmailBackend", you'll need to switch to BREVO_API_KEY at the same time.

I don't have any particular schedule for removing the deprecated compatibility versions. (They don't really add maintenance overhead.)

- Replace "SendinBlue" with "Brevo"
  throughout the code.
- Maintain deprecated compatibility
  versions on the old names/URLs.
  (Split into separate commit
  to make renamed files more
  obvious.)
- Update docs to reflect change,
  provide migration advice.
- Update integration workflow.
(See previous commit.)

- Maintain deprecated compatibility
  versions on the old names/URLs.
  (Split into separate commit
  to make renamed files more
  obvious.)
@medmunds medmunds force-pushed the feature/rename-sendinblue branch from 419c40a to 948ab2b Compare March 12, 2024 01:52
@medmunds
Copy link
Contributor Author

[Split into two commits, which makes it possible to see the actual diffs in the renamed files before adding the compatibility versions on the original filenames: backends/sendinblue.py → backends/brevo.py; webhooks/sendinblue.py → webhooks/brevo.py]

@medmunds medmunds merged commit 948ab2b into main Mar 12, 2024
49 checks passed
@medmunds medmunds deleted the feature/rename-sendinblue branch March 12, 2024 21:08
@medmunds
Copy link
Contributor Author

(Released in Anymail 10.3)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant