| Name | tap-pipedream JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | `tap-pipedream` is a Singer tap for Pipedream, built with the Meltano SDK for Singer Taps. |
| upload_time | 2024-01-02 23:39:57 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
elt
pipedream
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# tap-pipedream
<div>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-pipedream/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-pipedream/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-pipedream/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-pipedream"/>
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://pypi.org/p/tap-pipedream/">
<img alt="Python versions" src="https://img.shields.io/pypi/pyversions/tap-pipedream"/>
</a>
</div>
Singer tap for [Pipedream](https://pipedream.com/). Built with the [Meltano Singer SDK](https://sdk.meltano.com).
</div>
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| token | True | None | API Token for Pipedream |
| start_date | False | None | Earliest timestamp to get data from |
| 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-pipedream --about`
### Source Authentication and Authorization
To generate an API key, follow the instructions [in the docs](https://pipedream.com/docs/api/auth/#pipedream-api-key).
## Usage
You can easily run `tap-pipedream` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-pipedream --version
tap-pipedream --help
tap-pipedream --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 tests:integration
```
You can also test the `tap-pipedream` 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._
Install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-pipedream
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-pipedream --version
# OR run a test `elt` pipeline:
meltano elt tap-pipedream 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": "",
"name": "tap-pipedream",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"keywords": "ELT,Pipedream,singer.io",
"author": "",
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a0/0d/f5a06843f0e8db6828682d458a5234e0083813d0007cf9d8dc357397b5f1/tap_pipedream-0.2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-pipedream\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-pipedream/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-pipedream/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-pipedream/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-pipedream\"/>\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://pypi.org/p/tap-pipedream/\">\n <img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/tap-pipedream\"/>\n </a>\n</div>\n\nSinger tap for [Pipedream](https://pipedream.com/). Built with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n</div>\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| token | True | None | API Token for Pipedream |\n| start_date | False | None | Earliest timestamp to get data from |\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-pipedream --about`\n\n### Source Authentication and Authorization\n\nTo generate an API key, follow the instructions [in the docs](https://pipedream.com/docs/api/auth/#pipedream-api-key).\n\n## Usage\n\nYou can easily run `tap-pipedream` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-pipedream --version\ntap-pipedream --help\ntap-pipedream --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 tests:integration\n```\n\nYou can also test the `tap-pipedream` 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\nInstall Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-pipedream\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-pipedream --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-pipedream 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": "",
"summary": "`tap-pipedream` is a Singer tap for Pipedream, built with the Meltano SDK for Singer Taps.",
"version": "0.2.0",
"project_urls": {
"documentation": "https://github.com/edgarrmondragon/tap-pipedream#readme",
"homepage": "https://github.com/edgarrmondragon/tap-pipedream",
"repository": "https://github.com/edgarrmondragon/tap-pipedream"
},
"split_keywords": [
"elt",
"pipedream",
"singer.io"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "efcb3b50d294078cbea039bb7423cb895b23ed9bf7236dc1b8e7118b92b0e22c",
"md5": "135a1b9b8c8d8697c67d016ee26c30e1",
"sha256": "7095eef889640cbe3db0e08e2e6f2656c188d046d719f2c6ad58ad6215b7b38c"
},
"downloads": -1,
"filename": "tap_pipedream-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "135a1b9b8c8d8697c67d016ee26c30e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10481,
"upload_time": "2024-01-02T23:39:55",
"upload_time_iso_8601": "2024-01-02T23:39:55.586751Z",
"url": "https://files.pythonhosted.org/packages/ef/cb/3b50d294078cbea039bb7423cb895b23ed9bf7236dc1b8e7118b92b0e22c/tap_pipedream-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a00df5a06843f0e8db6828682d458a5234e0083813d0007cf9d8dc357397b5f1",
"md5": "083538d9a713b2914323e4b616ebda3d",
"sha256": "4b158d3b3d378ea7403db1eb0e44d6457de485371d448e9d555b5c1d847f9993"
},
"downloads": -1,
"filename": "tap_pipedream-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "083538d9a713b2914323e4b616ebda3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13213,
"upload_time": "2024-01-02T23:39:57",
"upload_time_iso_8601": "2024-01-02T23:39:57.129537Z",
"url": "https://files.pythonhosted.org/packages/a0/0d/f5a06843f0e8db6828682d458a5234e0083813d0007cf9d8dc357397b5f1/tap_pipedream-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 23:39:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-pipedream#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-pipedream"
}
