matatika / tap-veeqo

Singer tap for Veeqo

tap-veeqo

tap-veeqo is a Singer tap for Veeqo.

Built with the Meltano Tap SDK for Singer Taps.

Overview

tap-veeqo extracts raw data from the Veeqo API for the following resources:

• Orders
• Products
• Purchase Orders
• Suppliers
• Warehouses
• Customers
• Stores
• Delivery Methods
• Tags
• Employees
• Product Brands
• Product Tags
• Sellables

Installation

# pip
pip install git+https://github.com/Matatika/tap-veeqo

# pipx
pipx install git+https://github.com/Matatika/tap-veeqo

# poetry
poetry add git+https://github.com/Matatika/tap-veeqo

Configuration

Accepted Config Options

Name	Required	Default	Description
api_key	Yes		Your user API key

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

tap-veeqo --about

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

Before using tap-veeqo, you will need to generate an API key for the Veeqo user you want to authenticate as.

User roles

There is currently no documentation on how Veeqo user roles affect API access. This tap was developed and tested using a test user with the Admin role, for which all resources are accessible - your milage may vary with other roles.

Usage

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

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

poetry run pytest

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

poetry run tap-veeqo --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.

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

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

Now you can test and orchestrate using Meltano:

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