tap-teamtailor

tap-teamtailor is a Singer tap for teamtailor.

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-teamtailor --about

attribute name	Required	Description
api_key	True	The api key to authorize against the API service
api_url	False	The base url for the API service. (default: https://api.teamtailor.com)
api_version	False	The api version for the API service. (default: 20231215)

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

Create an API key following the documentation

Usage

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

Executing the Tap Directly

tap-teamtailor --version
tap-teamtailor --help
tap-teamtailor --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_teamtailor/tests subfolder and then run:

poetry run pytest

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

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

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

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

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

Now you can test and orchestrate using Meltano:

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