Annotell Authentication
Project description
Annotell Authentication
Python 3 library providing foundations for Annotell Authentication
on top of the requests
library.
Builds on the standard Oauth 2.0 Client Credentials flow. There are a few ways to provide auth credentials to our api
clients. Annotell Python clients such as in annotell-ams
, or annotell-input-api
accept an auth
parameter that
can be set explicitly or you can omit it and use environment variables.
There are a few ways to set your credentials in auth
.
- Set the environment variable
ANNOTELL_CREDENTIALS
to point to your Annotell Credentials file. The credentials will contain the Client Id and Client Secret. - Set to the credentials file path like
auth="~/.config/annotell/credentials.json"
- Set environment variables
ANNOTELL_CLIENT_ID
andANNOTELL_CLIENT_SECRET
- Set to credentials tuple
auth=(client_id, client_secret)
API clients such as the InputApiClient
accept this auth
parameter.
Under the hood, they all use the AuthSession class which is implements a requests
session with automatic token
refresh.
from annotell.auth.authsession import FaultTolerantAuthRequestSession
sess = FaultTolerantAuthRequestSession()
# make call to some Annotell service with your token. Use default requests
sess.get("https://api.annotell.com")
Changelog
1.6 (2021-02-21)
- Expose underlying
requests.Session
onFaultTolerantAuthRequestSession
- Fix some thread locks
1.5 (2020-10-20)
- Add
FaultTolerantAuthRequestSession
that handles token refresh on long running sessions.
1.4 (2020-04-16)
- Add support for
auth
parameter, with path to credentials file orAnnotellCredentials
object - Drop support for legacy API token
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
Built Distribution
Hashes for annotell_auth-1.6.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86ff20ca642f4c81101b83a93cf12d68c4ef7955adfe7bca92bdf5b1eb0b8b04 |
|
MD5 | f4982ca83404a4861bc04fcecbe1101b |
|
BLAKE2b-256 | 03acaaa2bd4b17b2edad8c09ba1c731976e039fa758b7377b0f384a2f3a7dc78 |