Skip to main content

vdk-control-api-auth

monthly download count for vdk-control-api-auth

vdk-control-api-auth is a plugin library that implements authentication utilities used by vdk-control-cli and other plugins.

Usage

This is a library plugin, not a runnable plugin, and it is intended to be used as a dependency for other plugins, which need to authenticate users.

To use the library within a plugin or another Versatile Data Kit component, just import the Authentication class, and create an instance of it. The different authentication flows require different parameters to be specified.

Once everything is done, in order to authenticate, call .authenticate() on the Authentication instance.

Example Usage:

from vdk.plugin.control_api_auth.authentication import Authentication

auth = Authentication(
    token="<oauth-api-token>",
    authorization_url="https://some-authorization-endpoint",
    auth_type="api-token",
)

auth.authenticate()   # authenticate

auth.read_access_token()   # fetch the cached access token

Build and testing

In order to build and test a plugin go to the plugin directory and use ../build-plugin.sh script to build it

Metadata

Release files for vdk-control-api-auth 0.1.1431637373

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

Source distribution (sdist)

Source distribution for vdk-control-api-auth 0.1.1431637373
File Size Uploaded
vdk_control_api_auth-0.1.1431637373.tar.gz 16.5 kB Details

Release files / vdk_control_api_auth-0.1.1431637373.tar.gz

Download URL vdk_control_api_auth-0.1.1431637373.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d46395116d67386f5a7803866ba6e39e6c83b62a1728a51d97d4a361498ca829
BLAKE2b-256 checksum
How to use checksums
5bf96b41ba509248b39f92cc3267310d4ff513782cf49d0e39a2fc7037c4083d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.14
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