Git Product home page Git Product logo

createsend-python's Introduction

createsend Build Status

A python library which implements the complete functionality of the Campaign Monitor API.

Installation

pip install createsend

Examples

Basic usage

Retrieve a list of all your clients.

from createsend import *

CreateSend.api_key = 'your_api_key'

cs = CreateSend()
clients = cs.clients()

for c in clients:
  print "%s: %s" % (c.ClientID, c.Name)

Results in:

4a397ccaaa55eb4e6aa1221e1e2d7122: Client One
a206def0582eec7dae47d937a4109cb2: Client Two

Handling errors

If the createsend API returns an error, an exception will be thrown. For example, if you attempt to create a campaign and enter empty values for subject etc:

from createsend import *

CreateSend.api_key = 'your_api_key'

try:
  cl = Client("4a397ccaaa55eb4e6aa1221e1e2d7122")
  id = Campaign().create(cl.client_id, "", "", "", "", "", "", "", [], [])
  print "New campaign ID: %s" % id
except BadRequest as br:
  print "Bad request error: %s" % br
  print "Error Code:    %s" % br.data.Code
  print "Error Message: %s" % br.data.Message
except Exception as e:
  print "Error: %s" % e

Results in:

Bad request error: The CreateSend API responded with the following error - 304: Campaign Subject Required
Error Code:    304
Error Message: Campaign Subject Required

Expected input and output

The best way of finding out the expected input and output of a particular method in a particular class is to use the unit tests as a reference.

For example, if you wanted to find out how to call the Subscriber.add() method, you would look at the file test/test_subscriber.py

def test_add_with_custom_fields(self):
  self.subscriber.stub_request("subscribers/%s.json" % self.list_id, "add_subscriber.json")
  custom_fields = [ { "Key": 'website', "Value": 'http://example.com/' } ]
  email_address = self.subscriber.add(self.list_id, "[email protected]", "Subscriber", custom_fields, True)
  self.assertEquals(email_address, "[email protected]")

Contributing

  1. Fork the repository
  2. Make your changes, including tests for your changes.
  3. Ensure that the build passes, by running rake (CI runs on: 2.5, 2.6, and 2.7)
  4. It should go without saying, but do not increment the version number in your commits.
  5. Submit a pull request.

createsend-python's People

Contributors

jdennes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.