Skip to main content

API client that automatically handles token refresh

Project description

OpenRelik API Client

This Python package provides a simple API client (APIClient) that automatically handles token refresh on 401 (Unauthorized) responses.

  • Automatic token refresh: Seamlessly refreshes expired access tokens using a refresh token.
  • Easy-to-use interface: Simple methods for common HTTP requests (GET, POST, PUT, DELETE).
  • Customizable: Allows you to specify the API server URL, API key, and API version.

Installation

pip install openrelik-api-client

Example:

 import os
 from openrelik_api_client.api_client import APIClient

 # Initialize the API client
 api_server_url = "http://localhost:8710"

 # API key from environment variable
 api_key = os.getenv("OPENRELIK_API_KEY")

 # Create the API client. It will handle token refreshes automatically.
 api_client = APIClient(api_server_url, api_key)

 # Example GET request
 response = api_client.get("/users/me/")
 print(response.json())

How it works:

The APIClient utilizes a custom session class (TokenRefreshSession) that intercepts requests and checks for 401 responses. If a 401 response is encountered, it automatically attempts to refresh the access token using the provided refresh token. If the refresh is successful, the original request is retried with the new access token.

Obligatory Fine Print

This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openrelik_api_client-0.2.3.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openrelik_api_client-0.2.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file openrelik_api_client-0.2.3.tar.gz.

File metadata

  • Download URL: openrelik_api_client-0.2.3.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.10.11-1rodete2-amd64

File hashes

Hashes for openrelik_api_client-0.2.3.tar.gz
Algorithm Hash digest
SHA256 435203567d50eb83456b10b499065462326646a61f3218a4a024f82cd0544b66
MD5 f1ac9bd3d9c0dc9cb229dbef8cef7315
BLAKE2b-256 360fab975eacc32deada77911aec6b66356fdb2714cd2e93072d591f0e5fe688

See more details on using hashes here.

File details

Details for the file openrelik_api_client-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: openrelik_api_client-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.10.11-1rodete2-amd64

File hashes

Hashes for openrelik_api_client-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0230b266d37f56a51a0309b226d56a3ceb24b8b42d355168eee74b82ff315d6b
MD5 2c01f093a18a7c0958c6e6d3419a5cf8
BLAKE2b-256 48a0a813b6d69b80cc704087bfcaf712ae885a37bd94e4ab5975ff6dbc335cee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page