Skip to content

Singer.io tap for Reviews.io, built on the Meltano Singer SDK

Notifications You must be signed in to change notification settings

hotgluexyz/tap-reviewsio

Repository files navigation

tap-reviewsio

tap-reviewsio is a Singer tap for reviewsio.

Built with the Meltano Tap SDK for Singer Taps.

Installation

pipx install ./

Configuration

Usage

You can easily run tap-reviewsio by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-reviewsio --version
tap-reviewsio --help
tap-reviewsio --config CONFIG --discover > ./catalog.json

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_reviewsio/tests subfolder and then run:

poetry run pytest

You can also test the tap-reviewsio CLI interface directly using poetry run:

poetry run tap-reviewsio --help

Testing with Meltano

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:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-reviewsio
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-reviewsio --version
# OR run a test `elt` pipeline:
meltano elt tap-reviewsio target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.