An API wrapper written in Python to interact with HelloSign's API (http://www.hellosign.com)
Project description
Hellosign Python SDK
-------------------
[![Build Status](https://travis-ci.org/minhdanh/hellosign-python-sdk.png?branch=master)](https://travis-ci.org/minhdanh/hellosign-python-sdk)
[![Coverage Status](https://coveralls.io/repos/minhdanh/hellosign-python-sdk/badge.png)](https://coveralls.io/r/minhdanh/hellosign-python-sdk)
[![Code Health](http://landscape.io/github/minhdanh/hellosign-python-sdk/master/landscape.png)](http://landscape.io/github/minhdanh/hellosign-python-sdk/master)
[![Latest Version](https://pypip.in/v/hellosign-python-sdk/badge.png)](https://pypi.python.org/pypi/hellosign-python-sdk/)
[![Downloads](https://pypip.in/d/hellosign-python-sdk/badge.png)](https://pypi.python.org/pypi/hellosign-python-sdk/)
[![Dependency Status](https://gemnasium.com/minhdanh/hellosign-python-sdk.png)](https://gemnasium.com/minhdanh/hellosign-python-sdk)
An API wrapper written in Python to interact with HelloSign's API (http://www.hellosign.com)
Note: This is not the final Readme, and the package is not ready yet. It will be ready when it's ready (of course).
## Installation
Install using `easy_install`:
````sh
easy_install hellosign-python-sdk
````
Install using `pip`:
````sh
pip install hellosign-python-sdk
````
## Configuration
In your application, import `HSClient`:
````python
from hsclient import HSClient
````
Then create a HSClient object and pass authentication information to initialize it:
````python
# Initialize HSClient using email and password
client = HSClient(api_email="api_user@example.com", api_password="your_password")
# Initialize HSClient using api key
client = HSClient(api_key="your_api_key")
# Initialize HSClient using api token
client = HSClient(api_accesstoken="your_api_access_token", api_accesstokentype="your_api_access_token_type")
````
Note: In case you initialize the HSClient with all the above credentials, the priority order is as follow: api_accesstoken & api_accesstokentype, api_key, then api_email and api_password
## Usage
### Account
#### Get current account information
````python
client.get_account_info()
````
-------------------
[![Build Status](https://travis-ci.org/minhdanh/hellosign-python-sdk.png?branch=master)](https://travis-ci.org/minhdanh/hellosign-python-sdk)
[![Coverage Status](https://coveralls.io/repos/minhdanh/hellosign-python-sdk/badge.png)](https://coveralls.io/r/minhdanh/hellosign-python-sdk)
[![Code Health](http://landscape.io/github/minhdanh/hellosign-python-sdk/master/landscape.png)](http://landscape.io/github/minhdanh/hellosign-python-sdk/master)
[![Latest Version](https://pypip.in/v/hellosign-python-sdk/badge.png)](https://pypi.python.org/pypi/hellosign-python-sdk/)
[![Downloads](https://pypip.in/d/hellosign-python-sdk/badge.png)](https://pypi.python.org/pypi/hellosign-python-sdk/)
[![Dependency Status](https://gemnasium.com/minhdanh/hellosign-python-sdk.png)](https://gemnasium.com/minhdanh/hellosign-python-sdk)
An API wrapper written in Python to interact with HelloSign's API (http://www.hellosign.com)
Note: This is not the final Readme, and the package is not ready yet. It will be ready when it's ready (of course).
## Installation
Install using `easy_install`:
````sh
easy_install hellosign-python-sdk
````
Install using `pip`:
````sh
pip install hellosign-python-sdk
````
## Configuration
In your application, import `HSClient`:
````python
from hsclient import HSClient
````
Then create a HSClient object and pass authentication information to initialize it:
````python
# Initialize HSClient using email and password
client = HSClient(api_email="api_user@example.com", api_password="your_password")
# Initialize HSClient using api key
client = HSClient(api_key="your_api_key")
# Initialize HSClient using api token
client = HSClient(api_accesstoken="your_api_access_token", api_accesstokentype="your_api_access_token_type")
````
Note: In case you initialize the HSClient with all the above credentials, the priority order is as follow: api_accesstoken & api_accesstokentype, api_key, then api_email and api_password
## Usage
### Account
#### Get current account information
````python
client.get_account_info()
````
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hellosign-python-sdk-0.1.2.tar.gz
(10.4 kB
view hashes)
Close
Hashes for hellosign-python-sdk-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e845584d0a99df9fd0a89f4c33ba4dc098948b1176108b1cce44e71de4fd6f74 |
|
MD5 | 7a5150da1d11242f22363fa5fe3eb3ff |
|
BLAKE2b-256 | 90c0687ec3c3b9f57e3f1c615171774fa124f03fc2fa78737ad320cd37e0cef4 |