https://github.com/lumapps/tap-teamtailor
tap-teamtailor a Singer tap for Teamtailor built with the Singer SDK.
https://github.com/lumapps/tap-teamtailor
singer teamtailor
Last synced: 8 days ago
JSON representation
tap-teamtailor a Singer tap for Teamtailor built with the Singer SDK.
- Host: GitHub
- URL: https://github.com/lumapps/tap-teamtailor
- Owner: lumapps
- License: mit
- Created: 2024-01-11T13:00:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-15T17:02:00.000Z (over 2 years ago)
- Last Synced: 2025-12-26T06:07:06.602Z (5 months ago)
- Topics: singer, teamtailor
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 17
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tap-teamtailor
`tap-teamtailor` is a Singer tap for teamtailor.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
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](https://app.teamtailor.com/settings/integrations/api_keys)
## Usage
You can easily run `tap-teamtailor` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-teamtailor --version
tap-teamtailor --help
tap-teamtailor --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_teamtailor/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-teamtailor` CLI interface directly using `poetry run`:
```bash
poetry run tap-teamtailor --help
```
### Testing with [Meltano](https://www.meltano.com)
_**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:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-teamtailor
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# 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](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.