Python client for jersey-hmac-auth (https://github.com/bazaarvoice/jersey-hmac-auth)
Project description
# python-hmac-auth
HMAC authentication for Python client libraries.
This library makes it easy to add support for HMAC authentication in Python clients that:
1. Interface with a REST API that uses
[jersey-hmac-auth](https://github.com/bazaarvoice/jersey-hmac-auth) to implement HMAC authentication, and
2. Use the Python [Requests](http://docs.python-requests.org) library to make API calls.
It works by providing a custom authenticator for the Requests library that modifies outgoing API calls to encode
the requests for HMAC authentication.
## Getting Started
To install:
```python
pip install python-hmac-auth
```
In your code, import the `HmacAuth` class and specify it on the `auth` parameter when issuing API calls:
```python
import requests
from python_hmac_auth import HmacAuth
response = requests.get('http://example.com/api', auth=HmacAuth('your_api_key', 'your_secret_key'))
```
## User Guide
See the [User Guide](https://github.com/bazaarvoice/jersey-hmac-auth/wiki) for jersey-hmac-auth for more details
about HMAC authentication on the server and for clients libraries.
## Contributing
To get the code:
```sh
$ git clone git@github.com:bazaarvoice/python-hmac-auth.git
```
To submit a new request or issue, please visit the [Issues](https://github.com/bazaarvoice/python-hmac-auth/issues) page.
Pull requests are always welcome.
HMAC authentication for Python client libraries.
This library makes it easy to add support for HMAC authentication in Python clients that:
1. Interface with a REST API that uses
[jersey-hmac-auth](https://github.com/bazaarvoice/jersey-hmac-auth) to implement HMAC authentication, and
2. Use the Python [Requests](http://docs.python-requests.org) library to make API calls.
It works by providing a custom authenticator for the Requests library that modifies outgoing API calls to encode
the requests for HMAC authentication.
## Getting Started
To install:
```python
pip install python-hmac-auth
```
In your code, import the `HmacAuth` class and specify it on the `auth` parameter when issuing API calls:
```python
import requests
from python_hmac_auth import HmacAuth
response = requests.get('http://example.com/api', auth=HmacAuth('your_api_key', 'your_secret_key'))
```
## User Guide
See the [User Guide](https://github.com/bazaarvoice/jersey-hmac-auth/wiki) for jersey-hmac-auth for more details
about HMAC authentication on the server and for clients libraries.
## Contributing
To get the code:
```sh
$ git clone git@github.com:bazaarvoice/python-hmac-auth.git
```
To submit a new request or issue, please visit the [Issues](https://github.com/bazaarvoice/python-hmac-auth/issues) page.
Pull requests are always welcome.
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
python-hmac-auth-0.4.tar.gz
(7.1 kB
view hashes)
Built Distribution
Close
Hashes for python_hmac_auth-0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39d8e4ae3aa9a5ea172c9c72f0829b3277925d2292aaa330e390b367a802dc28 |
|
MD5 | 47e30f11b61a38b8aaffa2ab4bee4416 |
|
BLAKE2b-256 | 117b991bb15dbce489be65e8aac6b156e3037175bae218736b0ef6d1f5f1527f |