<div align="center">
# tap-betterstack
<div>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-betterstack/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-betterstack/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-betterstack/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-betterstack"/>
</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-betterstack/">
<img alt="Python versions" src="https://img.shields.io/pypi/pyversions/tap-betterstack"/>
</a>
</div>
Singer tap for [Better Stack](https://betterstack.com). Built with the [Meltano Singer SDK](https://sdk.meltano.com).
</div
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| token | True | None | API Token for Better Stack |
| start_date | False | None | Earliest datetime 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. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-betterstack --about`
## Streams
### Supported
* [`monitors`](https://betterstack.com/docs/uptime/api/list-all-existing-monitors/)
* [`monitor_groups`](https://betterstack.com/docs/uptime/api/list-all-existing-monitor-groups/)
* [`heartbeats`](https://betterstack.com/docs/uptime/api/list-all-existing-hearbeats/)
* [`heartbeat_groups`](https://betterstack.com/docs/uptime/api/list-all-existing-heartbeat-groups/)
* [`on_calls`](https://betterstack.com/docs/uptime/api/list-all-existing-on-call-calendars/)
* [`escalation_policies`](https://betterstack.com/docs/uptime/api/list-all-escalation-policies/)
* [`incidents`](https://betterstack.com/docs/uptime/api/list-all-incidents/)
* [`incident_events`](https://betterstack.com/docs/uptime/api/list-of-incident-timeline-events/)
* [`email_integrations`](https://betterstack.com/docs/uptime/api/list-all-email-integrations/)
* [`incoming_webhooks`](https://betterstack.com/docs/uptime/api/list-all-incoming-webhooks/)
* [`status_pages`](https://betterstack.com/docs/uptime/api/list-all-existing-status-pages/)
### Planned (PRs welcome!)
* [`status_page_sections`](https://betterstack.com/docs/uptime/api/list-existing-sections-of-a-status-page/)
* [`status_page_resources`](https://betterstack.com/docs/uptime/api/list-existing-resources-of-a-status-page/)
* [`status_page_reports`](https://betterstack.com/docs/uptime/api/list-existing-reports-on-a-status-page/)
* [`status_page_report_updates`](https://betterstack.com/docs/uptime/api/list-all-existing-status-updates-for-a-status-page-report/)
## Usage
You can easily run `tap-betterstack` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-betterstack --version
tap-betterstack --help
tap-betterstack --config CONFIG --discover > ./catalog.json
```
## Developer Resources
- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
poetry run pytest
```
You can also test the `tap-betterstack` CLI interface directly using `poetry run`:
```bash
poetry run tap-betterstack --help
```
### 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. Open the `meltano.yml` and follow any _"TODO"_ items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-betterstack
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-betterstack --version
# OR run a test `elt` pipeline:
meltano elt tap-betterstack 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": "https://github.com/edgarrmondragon/tap-betterstack",
"name": "tap-betterstack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ELT, singer.io, Better Stack",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0c/65/f95813bed3c53fe741f9cd657ff748038e6009aeb7b18b3442d8453f571a/tap_betterstack-0.2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-betterstack\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-betterstack/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-betterstack/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-betterstack/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-betterstack\"/>\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-betterstack/\">\n <img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/tap-betterstack\"/>\n </a>\n</div>\n\nSinger tap for [Better Stack](https://betterstack.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* `batch`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| token | True | None | API Token for Better Stack |\n| start_date | False | None | Earliest datetime 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| batch_config | False | None | |\n\nA full list of supported settings and capabilities is available by running: `tap-betterstack --about`\n\n## Streams\n\n### Supported\n\n* [`monitors`](https://betterstack.com/docs/uptime/api/list-all-existing-monitors/)\n* [`monitor_groups`](https://betterstack.com/docs/uptime/api/list-all-existing-monitor-groups/)\n* [`heartbeats`](https://betterstack.com/docs/uptime/api/list-all-existing-hearbeats/)\n* [`heartbeat_groups`](https://betterstack.com/docs/uptime/api/list-all-existing-heartbeat-groups/)\n* [`on_calls`](https://betterstack.com/docs/uptime/api/list-all-existing-on-call-calendars/)\n* [`escalation_policies`](https://betterstack.com/docs/uptime/api/list-all-escalation-policies/)\n* [`incidents`](https://betterstack.com/docs/uptime/api/list-all-incidents/)\n* [`incident_events`](https://betterstack.com/docs/uptime/api/list-of-incident-timeline-events/)\n* [`email_integrations`](https://betterstack.com/docs/uptime/api/list-all-email-integrations/)\n* [`incoming_webhooks`](https://betterstack.com/docs/uptime/api/list-all-incoming-webhooks/)\n* [`status_pages`](https://betterstack.com/docs/uptime/api/list-all-existing-status-pages/)\n\n### Planned (PRs welcome!)\n\n* [`status_page_sections`](https://betterstack.com/docs/uptime/api/list-existing-sections-of-a-status-page/)\n* [`status_page_resources`](https://betterstack.com/docs/uptime/api/list-existing-resources-of-a-status-page/)\n* [`status_page_reports`](https://betterstack.com/docs/uptime/api/list-existing-reports-on-a-status-page/)\n* [`status_page_report_updates`](https://betterstack.com/docs/uptime/api/list-all-existing-status-updates-for-a-status-page-report/)\n\n## Usage\n\nYou can easily run `tap-betterstack` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-betterstack --version\ntap-betterstack --help\ntap-betterstack --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n- [ ] `Developer TODO:` As a first step, scan the entire project for the text \"`TODO:`\" and complete any recommended steps, deleting the \"TODO\" references once completed.\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-betterstack` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-betterstack --help\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. Open the `meltano.yml` and follow any _\"TODO\"_ items listed in\nthe file.\n\nNext, install 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-betterstack\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-betterstack --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-betterstack 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\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "`tap-betterstack` is a Singer tap for Better Stack, built with the Meltano SDK for Singer Taps.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/edgarrmondragon/tap-betterstack#readme",
"Homepage": "https://github.com/edgarrmondragon/tap-betterstack",
"Repository": "https://github.com/edgarrmondragon/tap-betterstack"
},
"split_keywords": [
"elt",
" singer.io",
" better stack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b02e2b867bec929e26907a0ac13a04bf31c6eff9901bbe94e923feabeb9f9a75",
"md5": "07e744b4c1e41498667a64b50e7d870f",
"sha256": "13b9fecbd04162b72aae0cf7ba09fcfca69a8f76f9203c6b8c4f735f6ce8e1ed"
},
"downloads": -1,
"filename": "tap_betterstack-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07e744b4c1e41498667a64b50e7d870f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 12421,
"upload_time": "2024-11-19T18:47:12",
"upload_time_iso_8601": "2024-11-19T18:47:12.768928Z",
"url": "https://files.pythonhosted.org/packages/b0/2e/2b867bec929e26907a0ac13a04bf31c6eff9901bbe94e923feabeb9f9a75/tap_betterstack-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c65f95813bed3c53fe741f9cd657ff748038e6009aeb7b18b3442d8453f571a",
"md5": "8de65c692d46c29a5188c789740a0383",
"sha256": "a1c42ba00343fff8fd344c3d20e99cbb9826fc10e589ebfb632bd95e6f9baee6"
},
"downloads": -1,
"filename": "tap_betterstack-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8de65c692d46c29a5188c789740a0383",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12619,
"upload_time": "2024-11-19T18:47:14",
"upload_time_iso_8601": "2024-11-19T18:47:14.465393Z",
"url": "https://files.pythonhosted.org/packages/0c/65/f95813bed3c53fe741f9cd657ff748038e6009aeb7b18b3442d8453f571a/tap_betterstack-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 18:47:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-betterstack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-betterstack"
}
JSON
