Skip to main content
# 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.

Metadata

Release files for python-hmac-auth 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-hmac-auth 0.4
File Size Uploaded Provenance Actions
python-hmac-auth-0.4.tar.gz 7.1 kB Without provenance Details for python-hmac-auth-0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-hmac-auth 0.4
File Interpreter ABI Platform Actions
python_hmac_auth-0.4-py2.py3-none-any.whl Python 2, Python 3 none any Details for python_hmac_auth-0.4-py2.py3-none-any.whl

Total release size: 19.6 kB

Release files / python-hmac-auth-0.4.tar.gz

Download URL python-hmac-auth-0.4.tar.gz
Size 7.1 kB
Tags Source
SHA-256 checksum
How to use checksums
60e9ddbc2497dc09b690371480a15038a552872e3197b14acb31ac778356f97b
BLAKE2b-256 checksum
How to use checksums
5587c86cfa480ff46f8444af5c91ab822825d066bdd204cb8192f55560f76c75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / python_hmac_auth-0.4-py2.py3-none-any.whl

Download URL python_hmac_auth-0.4-py2.py3-none-any.whl
Size 12.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
39d8e4ae3aa9a5ea172c9c72f0829b3277925d2292aaa330e390b367a802dc28
BLAKE2b-256 checksum
How to use checksums
117b991bb15dbce489be65e8aac6b156e3037175bae218736b0ef6d1f5f1527f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for python-hmac-auth 0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page