Python Wrapper for the Beeswax API
The beeswax wrapper is a python API for the beeswax DSP
beeswax_wrapper is currently supported for python2 and python3.
$ pip install beeswax_wrapper
>>> from beeswax_wrapper import BeeswaxAPI, configure_endpoint
BeeswaxAPI is the main interface to the package.
It allows for seamless communication with the true beeswax API.
The API lazily loads a
BeeswaxDAL to access the API and manage authentication state.
BeeswaxDAL is shared among all BeeswaxAPI classes.
get_beeswax_dal() returns the single
BeeswaxDAL object used by the apis.
BeeswaxDAL object returned by this function affects all
Updates should be made to this dal using the
configure_endpoint function as follows:
>>> from beeswax_wrapper import BeeswaxAPI, configure_endpoint >>> api = BeeswaxAPI() >>> configure_endpoint('http://endpoint.api.beeswax.com/rest/') >>> api.dal.endpoint_url 'http://endpoint.api.beeswax.com/rest/'
BeeswaxAPI operates with an object restful structure.
The basic method calls are organised as
api.<object>.<restful_method> where the restful methods are:
Some keywords that are specific to each restful endpoint are supplied but the full list of keywords is available here: https://docs.beeswax.com/docs/getting-started
>>> from beeswax_wrapper import BeeswaxAPI >>> api = BeeswaxAPI() >>> # get account information for an id >>> api.accounts.retrieve(account_id=4) >>> # get a list of campaigns >>> api.campaigns.list() >>> # delete a lineitem by id >>> api.line_items.delete(line_item_id=62) >>> # change user >>> api.change_user('<username>', '<password>') >>> # cookies are preserved per class
BeeswaxAPI is metaclassed to raise only a
beeswax_wrapper authenticates once per
BeeswaxDAL instance. The authentication is for short connection durations only.
In the event that a connection times out or is unavailable, the
BeeswaxDAL will attempt to re-authenticate.
Credentials from the DAL are queried from the os keyring.
$ python beeswax_wrapper/credentials/credential_manager.py Beeswax Username: Beeswax Password: $
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size beeswax-wrapper-1.1.9.tar.gz (13.7 kB)||File type Source||Python version None||Upload date||Hashes View hashes|