Capabilities
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
Supported Python Versions
- 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.12+
- uv
Create and Run Tests
Run integration tests:
uvx --with=tox-uv tox -e 3.12
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.
-
Install all plugins
meltano install -
Check that the extractor is working properly
meltano invoke tap-fedidb --version
-
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.
Metadata
Release files for tap-fedidb 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tap_fedidb-0.6.0.tar.gz | 65.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tap_fedidb-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 74.8 kB
Release files / tap_fedidb-0.6.0.tar.gz
| Download URL | tap_fedidb-0.6.0.tar.gz |
|---|---|
| Size | 65.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
99af77fb4dedd79ae05137359a31cb7d03624d8083cf0ff9a7f86bb4f0ae7c76
|
|
BLAKE2b-256 checksum How to use checksums |
7fc06c6819454f1eea8a90cc6379cec1a2b17e533b359929730dd6a26756210e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 26, 2026.
Transparency logRelease files / tap_fedidb-0.6.0-py3-none-any.whl
| Download URL | tap_fedidb-0.6.0-py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
da9fe4778f722432e58510a2af247724288c8c2b24d4764d6e6cfcee84a68733
|
|
BLAKE2b-256 checksum How to use checksums |
84b3e7f538e8ba67b5b0392eea0b9c1d63ff3bfa9d5d2c356761537bc1d3d852
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 26, 2026.
Transparency log