Postmark library for python 2.6 and 2.7. Built on top of the requests library.
Branch: master
Clone or download
Latest commit 329ccae Aug 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
tests
.coveragerc
.gitignore update README & docs to refer to flask-pystmark; remove _build from r… Oct 11, 2013
.gitmodule add basic files; setup, tests folder, travis, pip Jan 21, 2013
.travis.yml
AUTHORS.md
LICENSE add basic files; setup, tests folder, travis, pip Jan 21, 2013
MANIFEST.in add MANIFEST.in to get setup.py to package correctly; bump version fo… Jun 13, 2013
README.md
_pystmark_meta.py add support for sending email with templates Oct 19, 2016
pystmark.py
requirements.txt rename requirements files Jun 13, 2013
setup.py

README.md

pystmark

PyPI version Build Status Coverage Status

Postmark API library for python 2.6, 2.7, 3.3 and pypy. Built on top of the requests library.

Web Framework Integration

Documentation

The full Sphinx-compiled documentation is available here: https://readthedocs.org/docs/pystmark/en/latest/

Example Usage

import pystmark

API_KEY = 'my_api_key'
SENDER = 'me@example.com'

# Send a single message
message = pystmark.Message(sender=SENDER, to='you@example.com', subject='Hi',
                           text='A message', tag='greeting')
pystmark.send(message, api_key=API_KEY)


# Send multiple messages (via Postmark's batch send API)
recipients = ['you{0}@example.com'.format(i) for i in xrange(20)]
messages = [pystmark.Message(sender=SENDER, to=to, subject='Hi',
                             text='A message', tag='greeting')
            for to in recipients]

response = pystmark.send_batch(messages, api_key=API_KEY)

# Check API response error
try:
    response.raise_for_status()
except pystmark.UnauthorizedError:
    print 'Use your real API key'

Contribution

  1. Fork this repo
  2. Make your changes and write a test for them
  3. Add yourself to the AUTHORS file and submit a pull request

Please run the tests with ./setup.py test --with-integration, with at least python2.7, before you make a pull request. Requirements for running the tests are in tests/requirements.txt. The other versions will be handled by travis-ci.

The pep8 tests may fail if using pypy due to this bug, so that test is disabled if pypy is detected.

Copyright and License

pystmark is licensed under the MIT license. See the LICENSE file for full details.