Skip to main content

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.961233967

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.961233967
File Size Uploaded
vdk-control-api-auth-0.1.961233967.tar.gz 15.3 kB Details

Release files / vdk-control-api-auth-0.1.961233967.tar.gz

Download URL vdk-control-api-auth-0.1.961233967.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c5b157107213f0991ccd665872040537d8dba94e960a56b562e760c2003b8eae
BLAKE2b-256 checksum
How to use checksums
24d28ca153348d980bd5df728305d8d8f10274363d2e515f0a2a62823bb7129c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12
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