pacnpal/django-anymail
1
0
Fork 0
mirror of https://github.com/pacnpal/django-anymail.git synced 2025-12-21 20:31:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

install: remove need to name [esp]

Browse Source 
Simplify install to just `pip install django-anymail`.
(Rather than `... django-anymail[mailgun]`

All of the ESPs so far require requests, so just move
that into the base requirements. (Chances are your
Django app already needs requests for some other
reason, anyway.)

Truly unique ESP dependencies (e.g., boto for
AWS-SES) could still use the setup extra features
mechanism.
This commit is contained in:
medmunds
2016-03-14 13:26:06 -07:00
parent f95bf1fbc4
commit fed98b14a8
8 changed files with 24 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/installation.rst
View File

@@ -6,24 +6,14 @@ Installation and configuration
Installing Anymail
------------------
Install Anymail from PyPI using pip.
Anymail uses python setuptools' "extra features" to pull in dependencies
for specific ESPs. (This avoids installing packages needed by ESPs
you aren't using.)
You'll want to include at least one ESP as an extra in your pip command.
E.g., for Anymail with Mailgun support:
It's easiest to install Anymail from PyPI using pip.
.. code-block:: console
$ pip install django-anymail[mailgun]
$ pip install django-anymail
...or with both Postmark and SendGrid support:
.. code-block:: console
$ pip install django-anymail[postmark,sendgrid]
If you don't want to use pip, you'll also need to install Anymail's
dependencies (requests and six).
.. _backend-configuration:

11
docs/troubleshooting.rst
View File

@@ -19,18 +19,15 @@ Figuring out what's wrong
**Check your ESPs API logs**
Many ESPs offer an incredibly-helpful log
of your recent API calls in their dashboards. Check the logs to see if the
Most ESPs offer some sort of API activity log in their dashboards.
Check the logs to see if the
data you thought you were sending actually made it to your ESP, and
if they recorded any errors there.
**Double-check common issues**
* Did you install Anymail with the ESPs you want available?
(E.g., `pip install django-anymail[mailgun,sendgrid]` --
*not* just `pip install django-anymail`.)
* Did you add any required settings for those ESPs to your settings.py?
(E.g., `ANYMAIL_MANDRILL_API_KEY`.)
* Did you add any required settings for your ESP to your settings.py?
(E.g., `ANYMAIL_SENDGRID_API_KEY` for SendGrid.) See :ref:`supported-esps`.
* Did you add ``'anymail'`` to the list of :setting:`INSTALLED_APPS` in settings.py?
* Are you using a valid from address? Django's default is "webmaster@localhost",
which won't cut it. Either specify the ``from_email`` explicitly on every message