Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.
/ tap-lever Public archive

Lever tap built with the Meltano Tap SDK for Singer Taps.

License

Notifications You must be signed in to change notification settings

immuta/tap-lever

Repository files navigation

tap-lever

tap-lever is a Singer tap for the Lever API. Documentation for the API can be found on Lever's website.

Built with the Meltano Tap SDK for Singer Taps.

Installation

  • Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
pipx install tap-lever

Configuration

Accepted Config Options

  • Developer TODO: Provide a list of config options accepted by the tap.

A full list of supported settings and capabilities for this tap is available by running:

tap-lever --about

Source Authentication and Authorization

  • Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.

Usage

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

Executing the Tap Directly

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

Developer Resources

  • Developer TODO: As a first step, scan the entire project for the text "TODO:" and complete any recommended steps, deleting the "TODO" references once completed.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-lever --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-lever
meltano install

Now you can test and orchestrate using Meltano:

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

About

Lever tap built with the Meltano Tap SDK for Singer Taps.

Resources

License

Stars

Watchers

Forks

Releases

No releases published