pybutton 1.1.0

Client for the Button API

This module is a thin client for interacting with Button’s API.

Please see the full API Docs for more information. For help, check out our Support page or get in touch.

Supported runtimes

• cPython 2.6, 2.7, 3.2, 3.3, 3.4, 3.5

Dependencies

• None

Usage

pip install pybutton

To create a client capable of making network requests, instantiate a pybutton.Client with your API key.

from pybutton import Client

client = Client('sk-XXX')

The client will always attempt to raise a pybutton.ButtonClientError in an error condition.

All API requests will return a pybutton.response.Response instance, which supports accessing data properties from the API response as attributes. To access the raw response dict, use #to_dict. For instance:

from pybutton import Client
from pybutton import ButtonClientError

client = Client("sk-XXX")

try:
    response = client.orders.get("btnorder-XXX")
except ButtonClientError as e:
    print(e)

print(response)
# <class pybutton.Response status: open, btn_ref: None, line_items: [], ...>

print(response.status)
# 'open'

print(response.to_dict())
# {'status': open, 'btn_ref': None, 'line_items': [], ...}

Configuration

You may optionally supply a config argument with your API key:

from pybutton import Client

client = Client("sk-XXX", {
  'hostname': 'api.testsite.com',
  'port': 80,
  'secure': False,
  'timeout': 5, # seconds
})

The supported options are as follows:

• hostname: Defaults to api.usebutton.com.

• port: Defaults to 443 if config.secure, else defaults to 80.

• secure: Whether or not to use HTTPS. Defaults to True. N.B: Button’s API is only exposed through HTTPS. This option is provided purely as a convenience for testing and development.

• timeout: The time in seconds that may elapse before network requests abort. Defaults to None.

Resources

We currently expose only one resource to manage, Orders.

Orders

n.b: all currency values should be reported in the smallest possible unit of that denomination, i.e. $1.00 should be reported as 100 (i.e. 100 pennies)

Create

from pybutton import Client

client = Client('sk-XXX')

response = client.orders.create({
    'total': 50,
    'currency': 'USD',
    'order_id': '2007',
    'finalization_date': '2017-08-02T19:26:08Z',
})

print(response)
# <class pybutton.Response total: 50, currency: 'USD', ...>

Get

from pybutton import Client

client = Client('sk-XXX')

response = client.orders.get('btnorder-XXX')

print(response)
# <class pybutton.Response total: 50, currency: 'USD', ...>

Update

from pybutton import Client

client = Client('sk-XXX')

response = client.orders.update('btnorder-XXX', {
    'total': 60,
})

print(response)
# <class pybutton.Response total: 60, currency: 'USD', ...>

Delete

from pybutton import Client

client = Client('sk-XXX')

response = client.orders.delete('btnorder-XXX')

print(response)
# <class pybutton.Response >

Contributing

• Building the egg: python setup.py bdist_egg

• Building the wheel: python setup.py bdist_wheel --universal

• Building the sdist: python setup.py sdist

• Installing locally: python setup.py install

• Running tests: python setup.py test

• Running lint: flake8