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

https://github.com/lumapps/tap-qoben-comeen

tap-qoben-comeen a Singer tap for Qoben API (Comeen) built with the Singer SDK.
https://github.com/lumapps/tap-qoben-comeen

lucca singer

Last synced: 8 days ago
JSON representation

tap-qoben-comeen a Singer tap for Qoben API (Comeen) built with the Singer SDK.

Awesome Lists containing this project

README

          

# tap-comeen-qoben

`tap-comeen-qoben` is a Singer tap for ComeenQoben.

Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

## Configuration

### Accepted Config Options

A full list of supported settings and capabilities for this
tap is available by running:

```bash
tap-comeen-qoben --about
```

### Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's
`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the `.env` file.

### Source Authentication and Authorization

## Usage

You can easily run `tap-comeen-qoben` by itself or in a pipeline using [Meltano](https://meltano.com/).

### Executing the Tap Directly

```bash
tap-comeen-qoben --version
tap-comeen-qoben --help
tap-comeen-qoben --config CONFIG --discover > ./catalog.json
```

## Developer Resources

Follow these instructions to contribute to this project.

### Initialize your Development Environment

Prerequisites:

- Python 3.10+
- [uv](https://docs.astral.sh/uv/)

```bash
uv sync
```

### Create and Run Tests

Create tests within the `tests` subfolder and
then run:

```bash
uv run pytest
```

You can also test the `tap-comeen-qoben` CLI interface directly using `uv run`:

```bash
uv run tap-comeen-qoben --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._

Use Meltano to run an EL pipeline:

```bash
# Install meltano
uv tool install meltano

# Test invocation
meltano invoke tap-comeen-qoben --version

# Run a test EL pipeline
meltano run tap-comeen-qoben 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.