skip to navigation
skip to content

ubersmith 0.3.0

Client library for the Ubersmith API 2.0

Latest Version: 0.3.11


pip install ubersmith

Example Use

First you’ll need to initialize the ubersmith package with your login credentials:

import ubersmith
ubersmith.init('http://ubersmith/api/2.0/', 'username', 'password')

Then you can make API calls:

from ubersmith import uber, client

These modules match the methods as documented in the Ubersmith API 2.0 docs.

Without Module State

ubersmith.init creates and stores a request handler with your login credentials. If for some reason you’d prefer to not have this module state then you can instantiate the request handler manually:

from ubersmith.api import RequestHandler
h = RequestHandler('http://ubersmith/api/2.0/', 'username', 'password')

and then explicitly pass it into any call function:

from ubersmith import uber, client

or you can access the call function directly on the handler and the handler will be implicitly passed into the call function for you:


Raw Processing

Alternatively you can process the request directly on the handler:

h.process_request('client.get', data={'email': ''})

although this will bypass any validation logic and response cleaning provided by the call function and just return the BaseResponse from ubersmith.


You’ll need to install the development dependencies:

pip install -r requirements-dev.txt

Running Tests

To run the tests:


To run the tests on multiple interpreters:


To run the tests and generate a coverage report:



To run the dev console copy over the example config file:

cp bin/ bin/

Edit it with your credentials then run the console:

python -i bin/

From here you can run commands against your dev instance:

>>> uber.method_list()
File Type Py Version Uploaded on Size
ubersmith-0.3.0.tar.gz (md5) Source 2014-08-30 422KB