`tap-fedidb` is a 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.8
- 3.9
- 3.10
- 3.11
- 3.12
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
pipx install hatch
Create and Run Tests
Run integration tests:
hatch run test:integration
You can also test the tap-fedidb
CLI interface directly:
hatch run sync:console -- --about --format=json
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.
Project details
Release history Release notifications | RSS feed
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
Hashes for tap_fedidb-0.0.1a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db35924ddf157554be5a6b8d48672b86ff5ec166399da278f7b23738db4dedbe |
|
MD5 | e5648a4007d5923a40b6542ecb278379 |
|
BLAKE2b-256 | 710bd9e3085c2633741c6c260dc14985387b34ef0e3d033329ae4b16dd602659 |