Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.43 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.43 KB
Raw

tap-thinkific

This repo contains a Singer "tap" for downloading data from www.thinkific.com. The tap conforms to the Singer specification and can be used standalone or with Meltano (recommended) to send data to wide variety of destinations for analysis. See here for a list of Meltano destinations: https://hub.meltano.com/loaders/.

The tap is built with the Meltano Tap SDK.

Supported Streams

The tap currently downloads data from these endpoints:

A full list of thinkific endpoints is available at https://developers.thinkific.com/api/api-documentation. Please submit an issue to request other endpoints or feel free to open up a PR.

Installation

Pip

This tap isn't currently published on PyPi. You can install directly with

pipx install git+https://github.com/birdiecare/tap-thinkific.git

Meltano

You can install this tap using Meltano via MeltanoHub.

meltano add extractor tap-thinkific --variant birdiecare

Configuration

The tap takes three configuration inputs:

{
    "api_key": "<your_thinkific_api_key>",
    "subdomain": "<your_thinkific_subdomain",
    "start_date": "2022-01-18T00:00:00Z"
}

Only enrollments created or updated after the start_date will be downloaded. The subdomain and api_key are obtained from your Thinkific settings. See here for instructions: https://developers.thinkific.com/api/api-key-auth

Usage

You can test the tap by itself or in a pipeline using Meltano.

Executing the Tap Directly

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

See https://www.singer.io/#what-it-is for more info on running singer taps and targets.

Run tap_thinkific tap in Docker Container

docker build --tag meltano_tap_thinkific:0.1 .
docker run --name my_tap_thinkific -d meltano_tap_thinkific:0.1

# Run the according to your .env file. Notice that it's loading data into Snowflake. Consider changing it if you want to use any other
docker run --env-file .env meltano_tap_thinkific:0.1 el tap-thinkific target-snowflake --state-id=thinkific-to-snowflake