Skip to content

edgarrmondragon/tap-bitso

Repository files navigation

tap-bitso

⚠️ Warning: this project is under active development, essential features are still missing and implementation subject to change. ⚠️

tap-bitso is a Singer tap for the Bitso API.

Built with the Meltano SDK for Singer Taps.

Installation

pipx install git+https://github.com/edgarrmondragon/tap-bitso.git

Configuration

Accepted Config Options

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

tap-bitso --about
Field Description Type Required Default
key Bitso API Key string yes
secret Bitso API Secret string yes
base_url Bitso API URL string no https://api.bitso.com
books Tickers to get data for list(string) no ["btc_mxn"]

Source Authentication and Authorization

This tap handles the digest access authentication for the Bitso API.

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

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.

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

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-bitso --version
# OR run a test `elt` pipeline:
meltano elt tap-bitso target-sqlite

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.