A Python wrapper around the Hyperwallet API
Project description
.. image:: https://travis-ci.org/hyperwallet/python-sdk.svg?branch=master
:target: https://travis-ci.org/hyperwallet/python-sdk/builds
.. image:: https://coveralls.io/repos/github/hyperwallet/python-sdk/badge.svg?branch=master
:target: https://coveralls.io/github/hyperwallet/python-sdk?branch=master
===========================
Hyperwallet REST SDK (Beta)
===========================
A library to manage users, transfer methods and payments through the Hyperwallet API
Installation
------------
.. code::
$ pip install hyperwallet-sdk
Documentation
-------------
Documentation is available at http://hyperwallet.github.io/python-sdk
API Overview
------------
To write an app using the SDK
* Register for a sandbox account and get your username, password and program
token at the `Hyperwallet Program Portal <https://portal.hyperwallet.com>`_.
* Import the Hyperwallet module
.. code::
import hyperwallet
* Create an instance of the Hyperwallet Client (with username, password and
program token)
.. code::
api = hyperwallet.Api(
"test-user",
"test-pass",
"prg-12345"
)
* Start making API calls (e.g. create a user)
.. code::
data = {
clientUserId: "test-client-id-1",
profileType: "INDIVIDUAL",
firstName: "Daffy",
lastName: "Duck",
email: "testmail-1@hyperwallet.com",
addressLine1: "123 Main Street",
city: "Austin",
stateProvince: "TX",
country: "US",
postalCode: "78701"
}
response = api.createUser(data)
Development
-----------
Set up a virtual environment:
.. code::
$ virtualenv venv
$ source venv/bin/activate
Install development dependencies:
.. code::
$ make dev
Run the tests:
.. code::
$ make test
Compile the documentation:
.. code::
$ make docs
Requirements
------------
The Hyperwallet API uses TLS 1.2. Please ensure that your SSL library
supports TLS 1.2.
Reference
---------
`REST API Reference <https://portal.hyperwallet.com/docs>`_
License
-------
`MIT <https://raw.githubusercontent.com/hyperwallet/python-sdk/master/LICENSE>`_
Changelog
=========
1.2.1 (current)
------------------
1.2.0 (2018-12-18)
------------------
- Added Client Token endpoint
1.1.4 (2018-12-04)
------------------
- Added PayPal account endpoint
1.1.3 (2018-07-05)
------------------
- Added transfer endpoint
1.1.2 (2018-03-20)
------------------
- Added bank card endpoint
1.1.1 (2017-10-11)
------------------
- Bumped version and first public release!
1.1.0 (2017-09-29)
------------------
- Completed coverage of all endpoints
- 100% code coverage
- Audited available attributes for each model
1.0.0 (2017-08-04)
------------------
- Added support for resource types as models
0.2.0 (2016-12-22)
------------------
- Added support for all API endpoints
- Created package structure for distribution on PyPi
- Added tests
0.1.0 (2016-09-06)
------------------
- Repository creation
- Added license
- Added readme
:target: https://travis-ci.org/hyperwallet/python-sdk/builds
.. image:: https://coveralls.io/repos/github/hyperwallet/python-sdk/badge.svg?branch=master
:target: https://coveralls.io/github/hyperwallet/python-sdk?branch=master
===========================
Hyperwallet REST SDK (Beta)
===========================
A library to manage users, transfer methods and payments through the Hyperwallet API
Installation
------------
.. code::
$ pip install hyperwallet-sdk
Documentation
-------------
Documentation is available at http://hyperwallet.github.io/python-sdk
API Overview
------------
To write an app using the SDK
* Register for a sandbox account and get your username, password and program
token at the `Hyperwallet Program Portal <https://portal.hyperwallet.com>`_.
* Import the Hyperwallet module
.. code::
import hyperwallet
* Create an instance of the Hyperwallet Client (with username, password and
program token)
.. code::
api = hyperwallet.Api(
"test-user",
"test-pass",
"prg-12345"
)
* Start making API calls (e.g. create a user)
.. code::
data = {
clientUserId: "test-client-id-1",
profileType: "INDIVIDUAL",
firstName: "Daffy",
lastName: "Duck",
email: "testmail-1@hyperwallet.com",
addressLine1: "123 Main Street",
city: "Austin",
stateProvince: "TX",
country: "US",
postalCode: "78701"
}
response = api.createUser(data)
Development
-----------
Set up a virtual environment:
.. code::
$ virtualenv venv
$ source venv/bin/activate
Install development dependencies:
.. code::
$ make dev
Run the tests:
.. code::
$ make test
Compile the documentation:
.. code::
$ make docs
Requirements
------------
The Hyperwallet API uses TLS 1.2. Please ensure that your SSL library
supports TLS 1.2.
Reference
---------
`REST API Reference <https://portal.hyperwallet.com/docs>`_
License
-------
`MIT <https://raw.githubusercontent.com/hyperwallet/python-sdk/master/LICENSE>`_
Changelog
=========
1.2.1 (current)
------------------
1.2.0 (2018-12-18)
------------------
- Added Client Token endpoint
1.1.4 (2018-12-04)
------------------
- Added PayPal account endpoint
1.1.3 (2018-07-05)
------------------
- Added transfer endpoint
1.1.2 (2018-03-20)
------------------
- Added bank card endpoint
1.1.1 (2017-10-11)
------------------
- Bumped version and first public release!
1.1.0 (2017-09-29)
------------------
- Completed coverage of all endpoints
- 100% code coverage
- Audited available attributes for each model
1.0.0 (2017-08-04)
------------------
- Added support for resource types as models
0.2.0 (2016-12-22)
------------------
- Added support for all API endpoints
- Created package structure for distribution on PyPi
- Added tests
0.1.0 (2016-09-06)
------------------
- Repository creation
- Added license
- Added readme
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
hyperwallet-sdk-1.2.0.tar.gz
(21.9 kB
view hashes)