sailthru-python-client
======================
For installation instructions, documentation, and examples please visit:
[http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/python](http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/python)
A simple client library to remotely access the `Sailthru REST API` as per [http://getstarted.sailthru.com/api](http://getstarted.sailthru.com/developers/api)
Python binding for [Sailthru API](http://getstarted.sailthru.com/api) based on [Requests](http://docs.python-requests.org/en/latest/)
It will make requests in `JSON` format.
Supports Python 2.6, 2.7, 3.3+
### Installation (Tested with Python 2.7.x)
Installing with [pip](http://www.pip-installer.org/):
pip install sailthru-client
### Running tests
Install tox and then type:
tox
### API Rate Limiting
Here is an example how to check rate limiting and throttle API calls based on that. For more information about Rate Limiting, see [Sailthru Documentation](https://getstarted.sailthru.com/new-for-developers-overview/api/api-technical-details/#Rate_Limiting)
```python
sailthru_client = SailthruClient(api_key, api_secret)
# ... make some api calls ...
rate_limit_info = sailthru_client.get_last_rate_limit_info('user', 'POST')
# get_last_rate_limit_info returns None if given endpoint/method wasn't triggered previously
if rate_limit_info is not None:
limit = rate_limit_info['limit'];
remaining = rate_limit_info['remaining'];
reset_timestamp = rate_limit_info['reset'];
# throttle api calls based on last rate limit info
if remaining <= 0:
seconds_till_reset = reset_timestamp - time.time()
# sleep or perform other business logic before next user api call
time.sleep(seconds_till_reset);
```
======================
For installation instructions, documentation, and examples please visit:
[http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/python](http://getstarted.sailthru.com/new-for-developers-overview/api-client-library/python)
A simple client library to remotely access the `Sailthru REST API` as per [http://getstarted.sailthru.com/api](http://getstarted.sailthru.com/developers/api)
Python binding for [Sailthru API](http://getstarted.sailthru.com/api) based on [Requests](http://docs.python-requests.org/en/latest/)
It will make requests in `JSON` format.
Supports Python 2.6, 2.7, 3.3+
### Installation (Tested with Python 2.7.x)
Installing with [pip](http://www.pip-installer.org/):
pip install sailthru-client
### Running tests
Install tox and then type:
tox
### API Rate Limiting
Here is an example how to check rate limiting and throttle API calls based on that. For more information about Rate Limiting, see [Sailthru Documentation](https://getstarted.sailthru.com/new-for-developers-overview/api/api-technical-details/#Rate_Limiting)
```python
sailthru_client = SailthruClient(api_key, api_secret)
# ... make some api calls ...
rate_limit_info = sailthru_client.get_last_rate_limit_info('user', 'POST')
# get_last_rate_limit_info returns None if given endpoint/method wasn't triggered previously
if rate_limit_info is not None:
limit = rate_limit_info['limit'];
remaining = rate_limit_info['remaining'];
reset_timestamp = rate_limit_info['reset'];
# throttle api calls based on last rate limit info
if remaining <= 0:
seconds_till_reset = reset_timestamp - time.time()
# sleep or perform other business logic before next user api call
time.sleep(seconds_till_reset);
```
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sailthru-client-2.3.5.tar.gz
(11.7 kB
view details)
File details
Details for the file sailthru-client-2.3.5.tar.gz.
File metadata
- Download URL: sailthru-client-2.3.5.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e61d721200cd25fa7f58668381fdcef8b6c99c890a057da623c469715985da60
|
|
| MD5 |
1a7e5179a3460c63880f31e872aa229b
|
|
| BLAKE2b-256 |
c98ed4d4f18496f0edb83f2dd2fb16b01724f64f93df58ae4c09eafe43f2ece9
|
