Skip to main content

Singer tap for FediDB, built with the Meltano SDK for Singer Taps.

Project description

tap-fedidb

Singer tap for FediDB.org.

Built with the Meltano Tap SDK for Singer Taps.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening
  • batch

Supported Python Versions

  • 3.10
  • 3.11
  • 3.12
  • 3.13
  • 3.14

Settings

This tap doesn't have any settings of its own, but it does support the following built-in SDK settings:

Setting Required Default Description
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly).
faker_config.seed False None Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale False None One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.
batch_config False None
batch_config.encoding False None Specifies the format and compression of the batch files.
batch_config.encoding.format False None Format to use for batch files.
batch_config.encoding.compression False None Compression format to use for batch files.
batch_config.storage False None Defines the storage layer to use when writing batch files
batch_config.storage.root False None Root path to use when writing batch files.
batch_config.storage.prefix False None Prefix to use when writing batch files.

A full list of supported settings and capabilities is available by running: tap-fedidb --about

Source Authentication and Authorization

The FediDB API doesn't require authentication at this time.

Usage

You can easily run tap-fedidb by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-fedidb --version
tap-fedidb --help
tap-fedidb --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

You will need the following tools to develop and test this tap:

  • Python 3.10+
  • uv

Create and Run Tests

Run integration tests:

uvx --with=tox-uv tox -e 3.10

You can also test the tap-fedidb CLI interface directly:

uvx --with=tox-uv tox -e sync

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Go ahead and install Meltano if you haven't already.

  1. Install all plugins

    meltano install
    
  2. Check that the extractor is working properly

    meltano invoke tap-fedidb --version
    
  3. Execute an ELT pipeline

    meltano run tap-fedidb target-jsonl
    

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tap_fedidb-0.5.3.tar.gz (74.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tap_fedidb-0.5.3-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file tap_fedidb-0.5.3.tar.gz.

File metadata

  • Download URL: tap_fedidb-0.5.3.tar.gz
  • Upload date:
  • Size: 74.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tap_fedidb-0.5.3.tar.gz
Algorithm Hash digest
SHA256 976be56af45b677cdff20984d806b281f862f65b39e25d20c70cf1e4588b4f49
MD5 75394e7d1f2f6921e329c511a547c993
BLAKE2b-256 1dc0efc950d9faa7f77294588fd7466149fe39b00b9f8cb0067ac3e08a194e20

See more details on using hashes here.

Provenance

The following attestation bundles were made for tap_fedidb-0.5.3.tar.gz:

Publisher: build.yml on reservoir-data/tap-fedidb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tap_fedidb-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: tap_fedidb-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tap_fedidb-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cfa5a639172634e178740ab7795ff4f4fd3125112ecffecc0c81b83d323685f0
MD5 73c6199497603aa2124f409fc948fd86
BLAKE2b-256 b94037c7a4c711c134a1888d53c9f1407f7ae65bc7c30fe378533da3882d67f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for tap_fedidb-0.5.3-py3-none-any.whl:

Publisher: build.yml on reservoir-data/tap-fedidb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page