Skip to content

Singer tap for Coda, built with the Meltano SDK for Singer Taps.

Notifications You must be signed in to change notification settings

reservoir-data/tap-coda

Repository files navigation

tap-coda

tap-coda is a Singer tap for Coda, built with the Meltano SDK for Singer Taps.

Built with the Meltano SDK for Singer Taps and Targets.

Capabilities

  • catalog
  • discover
  • about
  • stream-maps

Settings

Setting Required Default Description
auth_token True None The token to authenticate against the API service.

A full list of supported settings and capabilities is available by running: tap-coda --about

Source Authentication and Authorization

See the documentation: https://coda.io/developers/apis/v1#section/Authentication.

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-coda --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.

Install Meltano (if you haven't already) and any needed plugins:

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-coda --version
# OR run a test `elt` pipeline:
meltano elt tap-coda 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.

About

Singer tap for Coda, built with the Meltano SDK for Singer Taps.

Topics

Resources

Stars

Watchers

Forks

Languages