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.3.0.tar.gz (10.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.3.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openrelik_api_client-0.3.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for openrelik_api_client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f874cd2ea63ac0cd7e8950cd55095ab1f3fc50762c27d2849f3c569683db74f9
MD5 f5ecdbc54ddcf78b7913ebc8b792207a
BLAKE2b-256 eaf5855439bdb92f3ac277ac8c1e1ea0b82890617bcde4d8ec61c801eb6cc554

See more details on using hashes here.

Provenance

The following attestation bundles were made for openrelik_api_client-0.3.0.tar.gz:

Publisher: publish-pypi.yml on openrelik/openrelik-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for openrelik_api_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 faee99b880223b5c53868c184161e0678423e56a632f177155d236253cf77ee3
MD5 4514a3068324cef7de695177d6e90f49
BLAKE2b-256 4962926681356ba5c7c6ba1e80af0a48e226eb4c46e4931f28e66817be2b81bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for openrelik_api_client-0.3.0-py3-none-any.whl:

Publisher: publish-pypi.yml on openrelik/openrelik-api-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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