Hotglue SDK for Taps
This is a fork of Melanto's SingerSDK for special use in hotglue, an embedded integration platform for running Singer Taps and Targets.
Taps and targets built on the SDK are automatically compliant with the Singer Spec, the de-facto open source standard for extract and load pipelines.
OAuth Access Token Support
Taps can implement the --access-token CLI flag to refresh OAuth access tokens without running the tap directly.
Implementing Access Token Support
To enable this feature in your tap, override the access_token_support class method to return a tuple of (authenticator_class, auth_endpoint):
from hotglue_singer_sdk import Tap
from my_tap.auth import MyOAuthAuthenticator
class MyTap(Tap):
name = "tap-myservice"
@classmethod
def access_token_support(cls, connector=None):
"""Return the authenticator class and auth endpoint for token refresh.
Returns:
A tuple of (authenticator_class, auth_endpoint).
"""
default_url = "https://api.myservice.com/oauth/token"
# ommit if token url is not dynamic
dynamic_url = connector.config.get("auth_url")
url = dynamic_url or default_url
return (MyOAuthAuthenticator, url)
Authenticator Requirements
The authenticator class must implement the following methods:
is_token_valid()- ReturnsTrueif the current access token is still validupdate_access_token()- Refreshes the access token and updates the config file
The authenticator will be instantiated with these parameters:
stream- A dummy stream object withlogger,tap_name, andconfigattributesconfig_file- Path to the config file for writing updated tokensauth_endpoint- The OAuth token endpoint URL
Usage
Once implemented, users can refresh the access token using:
tap-myservice --config config.json --access-token
This will output the new access token as JSON:
{
"access_token": "new_token_value"
}
Note: The --access-token flag requires a config file path. It will not work with --config ENV or when omitting the config.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hotglue_singer_sdk-1.0.41.tar.gz.
File metadata
- Download URL: hotglue_singer_sdk-1.0.41.tar.gz
- Upload date:
- Size: 112.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6cb843ddb74a51c273892f45e49a7f87e41f84650ed1332b1ddc3c5b0ca04137
|
|
| MD5 |
b21c6bf79de28fb3230629f99a40ad15
|
|
| BLAKE2b-256 |
6d185aa4b72ce4e658c5f53ef6ade40f90c5c028c35d11d0b039da03bcbe49d6
|
File details
Details for the file hotglue_singer_sdk-1.0.41-py3-none-any.whl.
File metadata
- Download URL: hotglue_singer_sdk-1.0.41-py3-none-any.whl
- Upload date:
- Size: 139.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a3fcb6cd6e617c8a46dc9952bcdbd0740720d213fb00f2f8b29fe5c79176dc3
|
|
| MD5 |
4ce09ecc9607825716705978ada459b5
|
|
| BLAKE2b-256 |
cc6e4c42be0c6aa69c6fee7b7fed9a507d349c978e55fc5435dc19c1f6f1b50c
|
