tap-shipbob
is a Singer tap for ShipBob.
Built with the Meltano Tap SDK for Singer Taps.
-
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 tap-shipbob
-
Developer TODO:
Provide a list of config options accepted by the tap.
A full list of supported settings and capabilities for this tap is available by running:
tap-shipbob --about
-
Developer TODO:
If your tap requires special access on the source system, or any special authentication requirements, provide those here.
You can easily run tap-shipbob
by itself or in a pipeline using Meltano.
tap-shipbob --version
tap-shipbob --help
tap-shipbob --config CONFIG --discover > ./catalog.json
-
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.
pipx install poetry
poetry install
Create tests within the tap_shipbob/tests
subfolder and
then run:
poetry run pytest
You can also test the tap-shipbob
CLI interface directly using poetry run
:
poetry run tap-shipbob --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-shipbob
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-shipbob --version
# OR run a test `elt` pipeline:
meltano elt tap-shipbob target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.