Skip to content

YouCruit/tap-currencyfreaks

Repository files navigation

tap-currencyfreaks

tap-currencyfreaks is a Singer tap for CurrencyFreaks.

Built with the Meltano Tap SDK for Singer Taps.

Installation

pipx install git+https://github.com/YouCruit/tap-currencyfreaks.git

Configuration

Accepted Config Options

  • api_key require api key for your CurrencyFreaks account
  • symbols list of currencies you want to fetch. If none then all currencies are fetched. Recommended to improve performance.

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

tap-currencyfreaks --about

Usage

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

Executing the Tap Directly

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

poetry run pytest

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

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

Now you can test and orchestrate using Meltano:

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

Releases

No releases published

Packages

No packages published