README.md

tap-canvas-catalog

tap-canvas-catalog is a Singer tap for CanvasCatalog.

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

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

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

Next, install Meltano (if you haven't already) and any needed plugins:

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

Now you can test and orchestrate using Meltano:

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