Python Interface for the Sendy API
|Info:||Simple module to interface with the Sendy API (https://sendy.co/api)|
|Author:||Peter Sanchez (http://www.petersanchez.com) - (http://www.netlandish.com)|
- It was written for Python 2.7+
- Depends on the requests module
- Version 1.3b adds the new “title” variable to the create_campaign API call. It effects the default ordering of variables in the call. If you’re upgrading from a previous version please ensure that you account for the new ordering of variables. This new variable was added in Sendy v188.8.131.52
pip install sendypy
Basic Manual Install:
$ python setup.py build $ sudo python setup.py install
Alternative Install (Manually):
Place sendy directory in your Python path. Either in your Python installs site-packages directory or set your $PYTHONPATH environment variable to include a directory where the impersonate directory lives.
All the variables and response values are described in the Sendy API docs
Usage is simple
from sendy.api import SendyAPI api = SendyAPI(host='https://your-sendy-install.com/sendy/', api_key='YOUR_API_KEY')
You don’t need to set the api_key variable if you’re using the subscribe or unsubscribe methods. You can also provide the optional “debug” variable (defaults to False). This will print debug into to stdout when sending a request to your Sendy install.
api.subscribe('list_id_here', 'firstname.lastname@example.org', 'optional first name', custom_field_1='value', custom_field_2='value', ...)
api.create_campaign( from_name='Your Name', from_email='Your Sender Email', reply_to='Your Reply-to Email', title='Your Email Title', subject='Your Email Subject', plain_text='Plain Text Email Body', html_text='HTML Email Body', list_ids='list_id_1,list_id_2,list_id_3', brand_id='your brand id', query_string='Your query string', send_campaign=0, #default's to 0, use 1 to send email right away )
Copyright & Warranty
All documentation, libraries, and sample code are Copyright 2016 Netlandish Inc., Peter Sanchez <email@example.com>. The library and sample code are made available to you under the terms of the BSD license which is contained in the included file, BSD-LICENSE.
This software, and lots of other software like it, has been built in support of many of Netlandish’s own projects, and the projects of our clients. We would love to help you on your next project so get in touch by dropping us a note at firstname.lastname@example.org.