Skip to main content

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() - Returns True if the current access token is still valid
  • update_access_token() - Refreshes the access token and updates the config file

The authenticator will be instantiated with these parameters:

  • stream - A dummy stream object with logger, tap_name, and config attributes
  • config_file - Path to the config file for writing updated tokens
  • auth_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.

Metadata

Release files for hotglue-singer-sdk 1.0.54

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

Source distribution (sdist)

Source distribution for hotglue-singer-sdk 1.0.54
File Size Uploaded Provenance Actions
hotglue_singer_sdk-1.0.54.tar.gz 116.6 kB Without provenance Details for hotglue_singer_sdk-1.0.54.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hotglue-singer-sdk 1.0.54
File Interpreter ABI Platform Actions
hotglue_singer_sdk-1.0.54-py3-none-any.whl Python 3 none any Details for hotglue_singer_sdk-1.0.54-py3-none-any.whl

Total release size: 259.9 kB

Release files / hotglue_singer_sdk-1.0.54.tar.gz

Download URL hotglue_singer_sdk-1.0.54.tar.gz
Size 116.6 kB
Tags Source
SHA-256 checksum
How to use checksums
09d9050cfbc6ff114a5b9e0b0e9004df45bc6879991cf85cf988ebd56edb4e9a
BLAKE2b-256 checksum
How to use checksums
afe4d069e674fe8a6b843d4048acce3ea1f8828429ca7d0142e1253593cc6554
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

Release files / hotglue_singer_sdk-1.0.54-py3-none-any.whl

Download URL hotglue_singer_sdk-1.0.54-py3-none-any.whl
Size 143.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3eb36eebde2a414691d89bf75bf297f1c00c38252e3e04d46fab4d7eb405b8b8
BLAKE2b-256 checksum
How to use checksums
1e5cea5e0931f7a7da9d1cb1ea2b063ba70a658e3678e76fbe731a6a29832b34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

Security for hotglue-singer-sdk 1.0.54

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.54 This release

2 release files No provenance

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