| Name | tap-checkly JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | Singer tap for Checkly, built with the Meltano SDK for Singer Taps. |
| upload_time | 2024-01-02 20:57:14 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
checkly
elt
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# tap-checkly
<div>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-checkly/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-checkly/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-checkly/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-checkly"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-checkly/">
<img alt="License" src="https://img.shields.io/pypi/pyversions/tap-checkly"/>
</a>
</div>
Singer Tap for [Checkly](https://www.checklyhq.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 |
|:--------------------|:--------:|:-------:|:------------|
| account_id | True | None | Checkly Account ID |
| token | True | None | API Token for Checkly |
| start_date | False | None | Earliest datetime to get data from |
| include_paid_streams| False | 0 | Include streams that require a paid Checkly plan |
| 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-checkly --about`
## API Coverage
| API Endpoint | Supported | Notes |
| :---------------------------- | :-------: | :------------------------ |
| `/v1/alert-channels` | ✅ | |
| `/v1/alert-notifications` | ✅ | Payment required |
| `/v1/checks` | ✅ | |
| `/v1/check-alerts` | ✅ | |
| `/v1/check-groups` | ✅ | |
| `/v1/check-results/{checkId}` | N/A | [Heavily rate-limited][1] |
| `/v1/dashboards` | ✅ | |
| `/v1/locations` | ✅ | |
| `/v1/maintenance-windows` | ✅ | |
| `/v1/private-locations` | ✅ | |
| `/v1/runtimes` | ✅ | |
| `/v1/snippets` | ✅ | |
| `/v1/variables` | ✅ | |
A full list of supported settings and capabilities is available by running: `tap-checkly --about`
### Source Authentication and Authorization
## Usage
You can easily run `tap-checkly` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-checkly --version
tap-checkly --help
tap-checkly --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-checkly` 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-checkly --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-checkly 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.
[1]: https://developers.checklyhq.com/reference/getv1checkresultscheckid
Raw data
{
"_id": null,
"home_page": "",
"name": "tap-checkly",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"keywords": "Checkly,ELT,singer.io",
"author": "",
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/33/13/816d28b410ee81d073d93c83ef5bc5b517fd49335e7cfe2189bcd38eeaa0/tap_checkly-0.2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-checkly\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-checkly/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-checkly/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-checkly/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-checkly\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-checkly/\">\n <img alt=\"License\" src=\"https://img.shields.io/pypi/pyversions/tap-checkly\"/>\n </a>\n</div>\n\nSinger Tap for [Checkly](https://www.checklyhq.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| account_id | True | None | Checkly Account ID |\n| token | True | None | API Token for Checkly |\n| start_date | False | None | Earliest datetime to get data from |\n| include_paid_streams| False | 0 | Include streams that require a paid Checkly plan |\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-checkly --about`\n\n## API Coverage\n\n| API Endpoint | Supported | Notes |\n| :---------------------------- | :-------: | :------------------------ |\n| `/v1/alert-channels` | \u2705 | |\n| `/v1/alert-notifications` | \u2705 | Payment required |\n| `/v1/checks` | \u2705 | |\n| `/v1/check-alerts` | \u2705 | |\n| `/v1/check-groups` | \u2705 | |\n| `/v1/check-results/{checkId}` | N/A | [Heavily rate-limited][1] |\n| `/v1/dashboards` | \u2705 | |\n| `/v1/locations` | \u2705 | |\n| `/v1/maintenance-windows` | \u2705 | |\n| `/v1/private-locations` | \u2705 | |\n| `/v1/runtimes` | \u2705 | |\n| `/v1/snippets` | \u2705 | |\n| `/v1/variables` | \u2705 | |\n\nA full list of supported settings and capabilities is available by running: `tap-checkly --about`\n\n### Source Authentication and Authorization\n\n## Usage\n\nYou can easily run `tap-checkly` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-checkly --version\ntap-checkly --help\ntap-checkly --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-checkly` 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-checkly --version\n ```\n\n1. Execute an ELT pipeline\n\n ```bash\n meltano run tap-checkly 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 develop your own taps and targets.\n\n[1]: https://developers.checklyhq.com/reference/getv1checkresultscheckid\n",
"bugtrack_url": null,
"license": "",
"summary": "Singer tap for Checkly, built with the Meltano SDK for Singer Taps.",
"version": "0.2.0",
"project_urls": {
"documentation": "https://github.com/edgarrmondragon/tap-checkly/#readme",
"homepage": "https://github.com/edgarrmondragon/tap-checkly",
"repository": "https://github.com/edgarrmondragon/tap-checkly"
},
"split_keywords": [
"checkly",
"elt",
"singer.io"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7820b696d3ba488beadde17d036ffac2a908b44496e7a0a1db6b652c00e11e15",
"md5": "7d39d6cf205a61c4d9a01c755bad0f0c",
"sha256": "a09dcba84b4c50ca2562ea9b7aceb4b20df3c81665d801e26b53831ef243da34"
},
"downloads": -1,
"filename": "tap_checkly-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d39d6cf205a61c4d9a01c755bad0f0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32866,
"upload_time": "2024-01-02T20:57:12",
"upload_time_iso_8601": "2024-01-02T20:57:12.780614Z",
"url": "https://files.pythonhosted.org/packages/78/20/b696d3ba488beadde17d036ffac2a908b44496e7a0a1db6b652c00e11e15/tap_checkly-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3313816d28b410ee81d073d93c83ef5bc5b517fd49335e7cfe2189bcd38eeaa0",
"md5": "245e5b142a337eb4fbcdce9a50ab9618",
"sha256": "81e5e60bb96052e276c3a910d30e3a443020701d6a5fd8d4c2f62d11dae0828b"
},
"downloads": -1,
"filename": "tap_checkly-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "245e5b142a337eb4fbcdce9a50ab9618",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 36491,
"upload_time": "2024-01-02T20:57:14",
"upload_time_iso_8601": "2024-01-02T20:57:14.404386Z",
"url": "https://files.pythonhosted.org/packages/33/13/816d28b410ee81d073d93c83ef5bc5b517fd49335e7cfe2189bcd38eeaa0/tap_checkly-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 20:57:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-checkly",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-checkly"
}
