tap-canny

Singer tap for Canny, a feedback management platform..

Built with the Meltano Singer SDK.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

Settings

Setting	Required	Default	Description
api_key	True	None	API Key for Canny
start_date	False	None	Earliest datetime to get data from
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
flattening_enabled	False	None	'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth	False	None	The max depth to flatten schemas.

Authentication

See the Canny API docs for more information on how to authenticate with the Canny API.

Supported Streams

Stream	Endpoint	Replication Method
boards	/v1/boards/list	FULL_TABLE
categories	/v1/categories/list	FULL_TABLE
changelog_entries	/v1/entries/list	FULL_TABLE
comments	/v1/comments/list	FULL_TABLE
companies	/v1/companies/list	FULL_TABLE
opportunities	/v1/opportunities	FULL_TABLE
posts	/v1/posts/list	FULL_TABLE
tags	/v1/tags/list	FULL_TABLE
users	/v1/users/list	FULL_TABLE
votes	/v1/votes/list	FULL_TABLE

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

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install hatch

Create and Run Tests

Run integration tests:

hatch run test:integration

You can also test the tap-canny CLI interface directly:

hatch run sync:console -- --about --format=json

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. Go ahead and install Meltano if you haven't already.

1. Install all plugins

   meltano install

2. Check that the extractor is working properly

   meltano invoke tap-canny --version

3. Execute an ELT pipeline

   meltano run tap-canny target-jsonl