SparkPost Python API client
Project description
Sign up for a SparkPost account and visit our Developer Hub for even more content.
SparkPost Python API client
The super-mega-official Python package for using the SparkPost API.
Installation
Install from PyPI using pip:
$ pip install sparkpost
Get a key
Go to API & SMTP in the SparkPost app and create an API key. We recommend using the SPARKPOST_API_KEY environment variable:
from sparkpost import SparkPost
sp = SparkPost() # uses environment variable
Alternatively, you can pass the API key to the SparkPost class:
from sparkpost import SparkPost
sp = SparkPost('YOUR API KEY')
Send a message
Here at SparkPost, our messages are known as transmissions. Let’s use the underlying transmissions API to send a friendly test message:
from sparkpost import SparkPost
sp = SparkPost()
response = sp.transmissions.send(
recipients=['someone@somedomain.com'],
html='<p>Hello world</p>',
from_email='test@sparkpostbox.com',
subject='Hello from python-sparkpost'
)
print(response)
# outputs {u'total_accepted_recipients': 1, u'id': u'47960765679942446', u'total_rejected_recipients': 0}
Django Integration
The SparkPost python library comes with an email backend for Django. Put the following configuration in settings.py file.
SPARKPOST_API_KEY = 'API_KEY'
EMAIL_BACKEND = 'sparkpost.django.email_backend.SparkPostEmailBackend'
Replace API_KEY with an actual API key that you’ve generated in Get a Key section. Check out the full documentation on the Django email backend.
Documentation
Documentation for python-sparkpost
Contribute
Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
Fork the repository on GitHub and make your changes in a branch on your fork
Write a test which shows that the bug was fixed or that the feature works as expected.
Send a pull request. Make sure to add yourself to AUTHORS.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sparkpost-1.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7684b4887c571fe5e518200e3785f7365500cb7bfd7d1ab39d05a2d8609bc514 |
|
MD5 | 234e6178d6526a376b51d3c10a78b2f6 |
|
BLAKE2b-256 | 30151ff6cd51706e2615f06307da40374774521d905421c82c9cd3b896edee78 |