Skip to main content

A python client library for the AWeber API.

Project description

AWeber API Python Library
-----------------------
The AWeber API Python Library allows you to quickly get up and running with
integrating access to the AWeber API into your Python applications. This
egg requires the python-oauth2 to handle the authentication.

.. image:: https://secure.travis-ci.org/aweber/AWeber-API-Python-Library.png?branch=master
:target: https://secure.travis-ci.org/aweber/AWeber-API-Python-Library

Installation
============

This egg can be installed by checking out the source::

$ sudo python setup.py install

Or can be installed using easy_install::

$ easy_install aweber_api

Usage
=====

To connect the AWeber API Python Libray, you simply include the main class,
AWeberAPI in your application, then create an instace of it with your
application's consumer key and secret.::

from aweber_api import AWeberAPI
aweber = AWeberAPI(consumer_key, consumer_secret)
account = aweber.get_account(access_token, token_secret)

for list in account.lists:
print list.name

Handling Errors
+++++++++++++++

Sometimes errors happen and your application should handle them appropriately.
Whenever an API error occurs an AWeberAPIException will be raised with a
detailed error message and documentation link to explain whats wrong.

You should wrap any calls to the API in a try/except block.

Common Errors:
* Resource not found (404 error)
* Your application has been rate limited (403 error)
* Bad request (400 error)
* API Temporarily unavailable (503 error)

Refer to https://labs.aweber.com/docs/troubleshooting for the complete list::

from aweber_api import AWeberAPI, APIException
aweber = AWeberAPI(consumer_key, consumer_secret)
account = aweber.get_account(access_token, token_secret)


try:
invalid_resource = account.load_from_url('/idontexist')
except APIException, exc:
print '404! {0}'.format(exc)

try:
print len(account.lists)
except APIException, exc:
print 'hmm, something unexpected happened!: {0}'.format(exc)


Getting request tokens / access tokens
++++++++++++++++++++++++++++++++++++++

You can also use the AWeberAPI object to handle retrieving request tokens::

from aweber_api import AWeberAPI
aweber = AWeberAPI(consumer_key, consumer_secret)
request_token, request_token_secret = aweber.get_request_token(callback_url)
print aweber.authorize_url

As well as access tokens::

from aweber_api import AWeberAPI
aweber = AWeberAPI(consumer_key, consumer_secret)
aweber.user.verifier = verifier
aweber.user.request_token = request_token
aweber.user.token_secret = request_token_secret
access_token, access_token_secret = aweber.get_access_token()


Full Pylons example
+++++++++++++++++++

Here is a simple Pylons example that uses the AWeber API Python Library to get
a request token, have it authorized, and then print some basic stats about the
web forms in that user's lists::

from pylons import session, request, tmpl_context as c
from pylons.controllers.util import redirect

from awebertest.lib.base import BaseController, render

from aweber_api import AWeberAPI

url = 'http://localhost:5000'
consumer_key = "vjckgsr5y4gfOa3PWnf"
consumer_secret = "u3sQ7vGGJBfds4q5dfgsTESi685c5x2wm6gZuIj"
class DemoController(BaseController):

def __before__(self):
self.aweber = AWeberAPI(consumer_key, consumer_secret)

def index(self):
token, secret = self.aweber.get_request_token(url+'/demo/get_access')
session['request_token_secret'] = secret
session.save()
redirect(self.aweber.authorize_url)

def get_access(self):
self.aweber.user.request_token = request.params['oauth_token']
self.aweber.user.token_secret = session['request_token_secret']
self.aweber.user.verifier = request.params['oauth_verifier']
session['token'], session['secret'] = self.aweber.get_access_token()
session.save()
redirect(url+'/demo/show')

def show(self):
c.account = self.aweber.get_account(session['token'], session['secret'])
return render('data.mako')


In `data.mako`::

<!DOCTYPE html>
<html lang="en">
<body>
<h1>Web Forms</h1>
% for list in c.account.lists:
<b>List Id:</b> ${list.id}, name: ${list.name}<br />
<b>Currently has:</b> ${len(list.web_forms)} web forms
<ul>
% for form in list.web_forms:
<li>Form Id: ${form.id}, name: ${form.name}</li>
% endfor
</ul>
% endfor
</body>
</html>

Project details


Release history Release notifications

History Node

1.4.0

History Node

1.2.1

History Node

1.2.0

This version
History Node

1.1.4

History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.4

History Node

1.0.3

History Node

1.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
aweber_api-1.1.4.tar.gz (11.1 kB) Copy SHA256 hash SHA256 Source None Feb 14, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page