Skip to main content

Python Interface for the Sendy API

Project description

sendypy nlshield

Info:

Simple module to interface with the Sendy API (https://sendy.co/api)

Version:

0.1

Author:

Peter Sanchez (http://www.petersanchez.com) - (http://www.netlandish.com)

Dependencies

  • It was written for Python 2.7+

  • Depends on the requests module

Installation

PIP:

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.

Use

All the variables and response values are described in the Sendy API docs

Usage is simple

from sendy 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.

Subscribe

api.subscribe('list_id_here', 'email@address.com', 'optional first name', custom_field_1='value', custom_field_2='value', ...)

Unsubscribe

api.unsubscribe('list_id_here', 'email@address.com')

Delete

api.delete('list_id_here', 'email@address.com')

Subscription Status

api.subscription_status('list_id_here', 'email@address.com')

Subscriber Count

api.subscriber_count('list_id_here')

Create Campaign

api.create_campaign(
    from_name='Your Name',
    from_email='Your Sender Email',
    reply_to='Your Reply-to Email',
    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
)

Commercial Support

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 hello@netlandish.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sendypy-0.1.1b0.tar.gz (4.3 kB view details)

Uploaded Source

File details

Details for the file sendypy-0.1.1b0.tar.gz.

File metadata

  • Download URL: sendypy-0.1.1b0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sendypy-0.1.1b0.tar.gz
Algorithm Hash digest
SHA256 d4c1bf956c98b5fec227cf5993fe406782183d2e43ea768314b6d674b960cd7a
MD5 647610f4d81ac602b2a9f0447914b844
BLAKE2b-256 1ae6a8275feefbc57b61bf693c962c97c2b60c9eacd1267bf1485b7e281611c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page