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

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.824443273
File Size Uploaded
vdk-control-api-auth-0.1.824443273.tar.gz 14.4 kB Details

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

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