tap-getresponse
is a Singer tap for GetResponse.
Built with the Meltano Tap SDK for Singer Taps.
Setting | Required | Default | Description |
---|---|---|---|
auth_token | True | None | GetResponse token API. |
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.
# .env
TAP_GETRESPONSE_AUTH_TOKEN=... # your token!
To get your API Token, follow the official documentation.
You can easily run tap-getresponse
by itself or in a pipeline using Meltano.
meltano install
meltano select tap-getresponse <entity> <attribute>
meltano select tap-getresponse --exclude <entity> <attribute>
# For example:
meltano select tap-getresponse webinars "*"
Verify that only the intended entities and attributes are now selected using meltano select --list
:
meltano select tap-getresponse --list
Run your newly added GetResponse extractor and chosen loader in a pipeline using meltano run
:
meltano run tap-getresponse <loader>
# For example:
meltano run tap-getresponse target-jsonl
There is also the meltano elt
(or meltano el
) command which is a more rigid command for running only EL pipelines.
Or directly using the meltano invoke
, which only executes a single plugin at a time. This can be useful for debugging the extractor (meltano invoke tap-getresponse
).
# Test invocation:
meltano invoke tap-getresponse --version
# OR run a test `elt` pipeline:
meltano elt tap-getresponse <loader>
# Example
meltano elt tap-getresponse target-jsonl
Follow these instructions to contribute to this project.
pipx install poetry
poetry install
Create tests within the tests
subfolder and
then run:
poetry run pytest
You can also test the tap-getresponse
CLI interface directly using poetry run
:
poetry run tap-getresponse --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-getresponse
meltano install
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.