Skip to main content

Fleetio Singer Tap (Beta)

Singer is an open-source specification on how data exchange scripts should communicate. These data extraction scripts, or singer taps and targets, use JSON-based Extraction Transform Load (ELT) formats, which makes any tap compatible with any target.

Getting Started​

There are multiple ways on using our singer tap, but we will show you on how to run this locally on your machine. Please be sure have Python3.10 or higher version installed where you run. Further details about our tap can be found on our GitHub Repository.

info

We built our Singer tap using the Meltano Singer SDK. It is highly recommended to run this using Meltano, but you can run our singer tap without the tool and on its own. Please refer to this section of our documentation on how to do so.

Using our singer tap​

info

Our singer tap is still in beta, so it is not officially on the Meltano Hub. These instructions are subject to change as our tap moves to an official support.

Below is a quick start on how to run our singer tap locally using Meltano:

  1. Clone our repository git clone https://github.com/fleetio/tap-fleetio.git
  2. Install Meltano pipx install meltano
  3. Change into the directory where our code was cloned tap-fleetio
  4. Install our tap meltano install
  5. Install a test load meltano add loader target-jsonl
  6. Set up an interactive configuration of our tap meltano config tap-fleetio set --interactive. This set requires an api_key and account_token that you can generate in your Fleetio Account. Please refer to the Quickstart section of the API
  7. After everything is set up, run meltano elt tap-fleetio target-jsonl

Scheduling our singer tap​

The simplest way to schedule our singer tap is by writing cron jobs, or you can use hosted and open-source solutions to run our singer tap. Below is a list of recommended services:

Hosted​

  1. Stitch (requires help from their team to import our tap)
  2. Arch

Open-Source​

  1. Prefect
  2. Airflow
info

Meltano has an official integration with Apache Airflow to schedule jobs. Please refer to their documentation on how to set this up.

Contributing​

Our Singer Tap was built with Meltano using their Singer SDK. If you are interested in contributing to our singer tap, please visit our GitHub Repository.