https://github.com/bazaarvoice/python-hmac-auth

Python SDK for https://github.com/bazaarvoice/jersey-hmac-auth
https://github.com/bazaarvoice/python-hmac-auth

Last synced: 2 months ago
JSON representation

Python SDK for https://github.com/bazaarvoice/jersey-hmac-auth

• Host: GitHub
• URL: https://github.com/bazaarvoice/python-hmac-auth
• Owner: bazaarvoice
• License: apache-2.0
• Created: 2014-04-10T21:42:44.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T20:59:58.000Z (over 3 years ago)
• Last Synced: 2024-10-07T18:08:50.704Z (3 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 12
• Watchers: 78
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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'))

```

If you need to you can adjust the **names** of the query parameter and headers used by HMAC by passing 

values for:

* api_key_query_param

* signature_http_header

* timestamp_http_header

* version_http_header

to the constructor as named parameters.

See the User Guide to find the default names for these headers.

Changes in the client must also be made at the server or authentication will not work.

## 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 [email protected]: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.