Skip to content

README.md

Latest commit

 

History

History
129 lines (84 loc) · 2.84 KB

README.md

File metadata and controls

129 lines (84 loc) · 2.84 KB

tap-branch

tap-branch is a Singer tap for Branch.

Built with the Meltano Tap SDK for Singer Taps.

Configuration

Accepted Config Options

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

tap-branch --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-branch by itself or in a pipeline using Meltano.

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

Prerequisites:

  • Python 3.10+
  • uv
uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

You can also test the tap-branch CLI interface directly using uv run:

uv run tap-branch --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.

Use Meltano to run an EL pipeline:

# Install meltano
uv tool install meltano

# Test invocation
meltano invoke tap-branch --version

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