An open API service indexing awesome lists of open source software.

https://github.com/reservoir-data/tap-betterstack

Singer tap for Better Stack. Built with the Meltano Singer SDK.
https://github.com/reservoir-data/tap-betterstack

betterstack betteruptime elt meltano singer-sdk uptime

Last synced: about 2 months ago
JSON representation

Singer tap for Better Stack. Built with the Meltano Singer SDK.

Awesome Lists containing this project

README

        

# tap-betterstack



pre-commit.ci status


License


Ruff


Python versions

Singer tap for [Better Stack](https://betterstack.com). Built with the [Meltano Singer SDK](https://sdk.meltano.com).

./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.