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.2.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.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openrelik_api_client-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 478a2bbe91f9b4dbbd1794cde130d2e6488c36a68df541be9a9af3ae64e5fe36
MD5 80db5516fd6c9936e02bbe0fd158fe77
BLAKE2b-256 96f257482914c089596bd1db5ace013f1953b584e25580136cde70da93d1d4df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openrelik_api_client-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6c3e785526b3c146b972fdcdfc7ce844e2fb23b4b203be6627fd1146f1ab514e
MD5 7e9b99e7f2a539a31f611f155026985a
BLAKE2b-256 0c3805867cf58b94638f63d8b72def68d7c9a240df8057b7f23d9a4937a567ae

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