Skip to main content

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.

Project details


Release history Release notifications | RSS feed

This version

0.4

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)

Uploaded source

Built Distribution

python_hmac_auth-0.4-py2.py3-none-any.whl (12.5 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page