Deprecated. This lib was for a past incarnation of the Stampr API that is no longer in production or supported
Python wrapper for the Stampr API. Tested with Python 2.7 & 3.3.
| Author: | Bil Bas ([email protected]) |
|---|---|
| Site: | https://github.com/stampr/stampr-api-python |
| Stampr: | http://stam.pr |
| License: | MIT |
On the command line:
$ pip install stampr
Before using stampr, it must be imported and your account authenticated:
import stampr
stampr.authenticate("username", "password")
In this case, all mailings will be in individual batches and with default config:
stampr.mail(my_address, dest_address_1, body1) stampr.mail(my_address, dest_address_2, body2)
Managing config and grouping mailings into a single batch:
# Config can be shared by batches.
config = stampr.config.Config()
# Batches contain one or more mailings.
with stampr.batch.Batch(config=config) as b:
with b.mailing() as m:
m.address = dest_address_1
m.return_address = my_address
m.data = body1
with b.mailing() as m:
m.address = dest_address_2
m.return_address = my_address
m.data = body2
And without using blocks:
# Config can be shared by batches. config = stampr.config.Config() # Batches contain one or more mailings. batch = stampr.batch.Batch(config=config) mailing1 = stampr.mailing.Mailing(batch=batch) mailing1.address = dest_address_1 mailing1.return_address = my_address mailing1.data = data1 mailing1.mail() mailing2 = stampr.mailing.Mailing(batch=batch) mailing2.address = dest_address_2 mailing2.return_address = my_address mailing2.data = data2 mailing2.mail()
Browsing:
config = stampr.config.Config[123123] configs = stampr.config.Config.all()
Configs cannot be deleted.
Browsing:
import datetime batch = stampr.batch.Batch[2451] start, end = datetime.datetime(2012, 1, 1, 0, 0, 0), datetime.datetime.now() batches = stampr.batch.Batch.browse(start, end) batches = stampr.batch.Batch.browse(start, end, status="processing")
Updating:
batch = stampr.batch.Batch[2451] batch.status = "archive"
Deletion:
batch = stampr.batch.Batch[2451] batch.delete()
Browsing:
import datetime mailing = stampr.mailing.Mailing[123123] start, end = datetime.datetime(2012, 1, 1, 0, 0, 0), datetime.datetime.now() my_batch = stampr.batch.Batch[1234] mailings = stampr.mailing.Mailing.browse(start, end) mailings = stampr.mailing.Mailing.browse(start, end, status="processing"] mailings = stampr.mailing.Mailing.browse(start, end, batch=my_batch] mailings = stampr.mailing.Mailing.browse(start, end, status="processing", batch=my_batch]
Syncing current status:
mailing = stampr.mailing.Mailing[2451] mailing.status #=> :received # ...later... mailing.sync() mailing.status #=> :render
Deletion:
mailing = stampr.mailing.Mailing[2451] mailing.delete()
Using Mustache (http://mustache.github.io/):
with stampr.batch.Batch() as b:
b.template = "<html>Hello {{name}}, would you like to buy some {{items}}!</html>"
with b.mailing() as m:
m.address = dest_address_1
m.return_address = my_address
m.data = { "name": "Marie", "items": "electric eels" }
with b.mailing() as m:
m.address = dest_address_2
m.return_address = my_address
m.data = { "name": "Romy", "items": "scintillating hackers" }
Additional dependencies:
$ pip install shovel $ pip install sphinx
Build documentation with:
$ shovel docs
Build release package:
$ shovel release
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request