Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 3.08 KB

README.md

File metadata and controls

107 lines (71 loc) · 3.08 KB
Raw

target-quickbooks

target-quickbooks is a Singer target for QuickBooks.

Build with the Meltano Target SDK.

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 target-quickbooks

Configuration

Accepted Config Options

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

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

target-quickbooks --about

Configure using environment variables

This Singer target 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

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

Usage

You can easily run target-quickbooks by itself or in a pipeline using Meltano.

Executing the Target Directly

target-quickbooks --version
target-quickbooks --help
# Test using the "Carbon Intensity" sample:
tap-carbon-intensity | target-quickbooks --config /path/to/target-quickbooks-config.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 target_quickbooks/tests subfolder and then run:

poetry run pytest

You can also test the target-quickbooks CLI interface directly using poetry run:

poetry run target-quickbooks --help

Testing with Meltano

Note: This target 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 target-quickbooks
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke target-quickbooks --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
meltano elt tap-carbon-intensity target-quickbooks

SDK Dev Guide

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