| Name | tap-fedidb JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Singer tap for FediDB, built with the Meltano SDK for Singer Taps. |
| upload_time | 2025-07-14 21:22:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
elt
fedidb
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-fedidb
Singer tap for [FediDB.org](https://fedidb.org).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) 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](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) 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](https://meltano.com/).
### Executing the Tap Directly
```bash
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](https://docs.astral.sh/uv/getting-started/installation/)
### Create and Run Tests
Run integration tests:
```bash
uvx --with=tox-uv tox -e 3.10
```
You can also test the `tap-fedidb` CLI interface directly:
```bash
uvx --with=tox-uv tox -e sync
```
### Testing with [Meltano](https://www.meltano.com)
_**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](https://docs.meltano.com/getting-started/installation/) if you haven't already.
1. Install all plugins
```bash
meltano install
```
1. Check that the extractor is working properly
```bash
meltano invoke tap-fedidb --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-fedidb target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": null,
"name": "tap-fedidb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrmondragon@hey.com>",
"keywords": "ELT, FediDB, singer.io",
"author": null,
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrmondragon@hey.com>",
"download_url": "https://files.pythonhosted.org/packages/6b/82/1fc148fa2a59a5fedede81284c18f9d7392dbd35c10afa0b7452ec809d04/tap_fedidb-0.4.0.tar.gz",
"platform": null,
"description": "# tap-fedidb\n\nSinger tap for [FediDB.org](https://fedidb.org).\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n# Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n* `batch`\n\n## Supported Python Versions\n\n* 3.10\n* 3.11\n* 3.12\n* 3.13\n* 3.14\n\n## Settings\n\nThis tap doesn't have any settings of its own, but it does support the following built-in SDK settings:\n\n| Setting | Required | Default | Description |\n| :-------------------------------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) 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). |\n| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |\n| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth | False | None | The max depth to flatten schemas. |\n| batch_config | False | None | |\n| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |\n| batch_config.encoding.format | False | None | Format to use for batch files. |\n| batch_config.encoding.compression | False | None | Compression format to use for batch files. |\n| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |\n| batch_config.storage.root | False | None | Root path to use when writing batch files. |\n| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |\n\nA full list of supported settings and capabilities is available by running: `tap-fedidb --about`\n\n### Source Authentication and Authorization\n\nThe FediDB API doesn't require authentication at this time.\n\n## Usage\n\nYou can easily run `tap-fedidb` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-fedidb --version\ntap-fedidb --help\ntap-fedidb --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\nYou will need the following tools to develop and test this tap:\n\n- Python 3.10+\n- [uv](https://docs.astral.sh/uv/getting-started/installation/)\n\n### Create and Run Tests\n\nRun integration tests:\n\n```bash\nuvx --with=tox-uv tox -e 3.10\n```\n\nYou can also test the `tap-fedidb` CLI interface directly:\n\n```bash\nuvx --with=tox-uv tox -e sync\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nYour project comes with a custom `meltano.yml` project file already created. Go ahead and [install Meltano](https://docs.meltano.com/getting-started/installation/) if you haven't already.\n\n1. Install all plugins\n\n ```bash\n meltano install\n ```\n\n1. Check that the extractor is working properly\n\n ```bash\n meltano invoke tap-fedidb --version\n ```\n\n1. Execute an ELT pipeline\n\n ```bash\n meltano run tap-fedidb target-jsonl\n ```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n",
"bugtrack_url": null,
"license": null,
"summary": "Singer tap for FediDB, built with the Meltano SDK for Singer Taps.",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://github.com/edgarrmondragon/tap-fedidb#readme",
"Homepage": "https://github.com/edgarrmondragon/tap-fedidb",
"Repository": "https://github.com/edgarrmondragon/tap-fedidb"
},
"split_keywords": [
"elt",
" fedidb",
" singer.io"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "529c700d8ab1845aa9a9538ad4a9e3ab489e55b8c6b652c03d2aff92c1d15774",
"md5": "f8702ecfecac1d032b6bb30f9919655d",
"sha256": "e6b122d6dc9334141c48ecc339271d704aaecc59e161d75d9d77bd282268df0f"
},
"downloads": -1,
"filename": "tap_fedidb-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8702ecfecac1d032b6bb30f9919655d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9711,
"upload_time": "2025-07-14T21:22:12",
"upload_time_iso_8601": "2025-07-14T21:22:12.233279Z",
"url": "https://files.pythonhosted.org/packages/52/9c/700d8ab1845aa9a9538ad4a9e3ab489e55b8c6b652c03d2aff92c1d15774/tap_fedidb-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6b821fc148fa2a59a5fedede81284c18f9d7392dbd35c10afa0b7452ec809d04",
"md5": "ea2b42cefb570c1640aba02ff81327ee",
"sha256": "f6ea90b7551e56121ee6a45c1cb7dd3018580d36779f18c649bcc58d07d0b9f9"
},
"downloads": -1,
"filename": "tap_fedidb-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "ea2b42cefb570c1640aba02ff81327ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 64016,
"upload_time": "2025-07-14T21:22:13",
"upload_time_iso_8601": "2025-07-14T21:22:13.546577Z",
"url": "https://files.pythonhosted.org/packages/6b/82/1fc148fa2a59a5fedede81284c18f9d7392dbd35c10afa0b7452ec809d04/tap_fedidb-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-14 21:22:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-fedidb#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-fedidb"
}
