| Name | tap-belvo JSON |
| Version |
0.1.0a2
JSON |
| download |
| home_page | None |
| Summary | Singer tap for Belvo, built with the Meltano SDK for Singer Taps. |
| upload_time | 2024-10-07 22:09:14 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
belvo
elt
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `tap-belvo`
Singer tap for Belvo.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| secret_id | True | None | Belvo API secret ID. |
| password | True | None | Belvo API password. |
| start_date | False | None | Earliest datetime to get data from |
| base_url | False | https://development.belvo.com | Base URL for the Belvo API |
| 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. |
| 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. |
A full list of supported settings and capabilities is available by running: `tap-belvo --about`
### Source Authentication and Authorization
See https://developers.belvo.com/reference/authentication-1.
## Usage
You can easily run `tap-belvo` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-belvo --version
tap-belvo --help
tap-belvo --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install hatch
```
### Create and Run Tests
Run integration tests:
```bash
hatch run test:integration
```
You can also test the `tap-belvo` CLI interface directly:
```bash
hatch run sync:console -- --about --format=json
```
### 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-belvo --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-belvo target-jsonl
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tap-belvo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"keywords": "Belvo, ELT, singer.io",
"author": null,
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d7/d4/210b547d97387a0bcd18f863128fd523eac80f5d1d92f6151abb5a693864/tap_belvo-0.1.0a2.tar.gz",
"platform": null,
"description": "# `tap-belvo`\n\nSinger tap for Belvo.\n\nBuilt with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| secret_id | True | None | Belvo API secret ID. |\n| password | True | None | Belvo API password. |\n| start_date | False | None | Earliest datetime to get data from |\n| base_url | False | https://development.belvo.com | Base URL for the Belvo API |\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| 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\nA full list of supported settings and capabilities is available by running: `tap-belvo --about`\n\n### Source Authentication and Authorization\n\nSee https://developers.belvo.com/reference/authentication-1.\n\n## Usage\n\nYou can easily run `tap-belvo` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-belvo --version\ntap-belvo --help\ntap-belvo --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\n```bash\npipx install hatch\n```\n\n### Create and Run Tests\n\nRun integration tests:\n\n```bash\nhatch run test:integration\n```\n\nYou can also test the `tap-belvo` CLI interface directly:\n\n```bash\nhatch run sync:console -- --about --format=json\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-belvo --version\n ```\n\n1. Execute an ELT pipeline\n\n ```bash\n meltano run tap-belvo target-jsonl\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "Singer tap for Belvo, built with the Meltano SDK for Singer Taps.",
"version": "0.1.0a2",
"project_urls": {
"Documentation": "https://github.com/edgarrmondragon/tap-belvo#readme",
"Homepage": "https://github.com/edgarrmondragon/tap-belvo",
"Source": "https://github.com/edgarrmondragon/tap-belvo"
},
"split_keywords": [
"belvo",
" elt",
" singer.io"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8d7879013e210bf2171a641f13a3d5abd509291a2aa51722fe2d9eec5e940e7",
"md5": "5a19dce39a2f81bac6e83339d2b8d77d",
"sha256": "5622d451e93455e42586598fbd6b3dfbdf69fe102c24bb32b2b4db6e8715f678"
},
"downloads": -1,
"filename": "tap_belvo-0.1.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a19dce39a2f81bac6e83339d2b8d77d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 139739,
"upload_time": "2024-10-07T22:09:13",
"upload_time_iso_8601": "2024-10-07T22:09:13.264317Z",
"url": "https://files.pythonhosted.org/packages/c8/d7/879013e210bf2171a641f13a3d5abd509291a2aa51722fe2d9eec5e940e7/tap_belvo-0.1.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7d4210b547d97387a0bcd18f863128fd523eac80f5d1d92f6151abb5a693864",
"md5": "2444bc1f9997c10146c45d567d0645f9",
"sha256": "930e01a9964279fadbdd0b4e90648396e866104431b3c9dd370d3710c211729c"
},
"downloads": -1,
"filename": "tap_belvo-0.1.0a2.tar.gz",
"has_sig": false,
"md5_digest": "2444bc1f9997c10146c45d567d0645f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 140822,
"upload_time": "2024-10-07T22:09:14",
"upload_time_iso_8601": "2024-10-07T22:09:14.825279Z",
"url": "https://files.pythonhosted.org/packages/d7/d4/210b547d97387a0bcd18f863128fd523eac80f5d1d92f6151abb5a693864/tap_belvo-0.1.0a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:09:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-belvo#readme",
"github_not_found": true,
"lcname": "tap-belvo"
}
