tap-clari
is a Singer tap for Clari.
Built with the Meltano Tap SDK for Singer Taps.
Install from GitHub:
pipx install git+https://github.com/jlloyd-widen/tap-clari.git@main
Setting | Required | Default | Description |
---|---|---|---|
api_key | True | None | The token to authenticate against the Clari API |
time_period | False | None | Fiscal Quarter for when you'd like to run your export. Must be passed in as a string (e.g. 'YYYY_QQ'). Defaults to the current quarter. |
forecast_ids | True | None | An array of IDs of the Forecast Tabs you would like to export data from. |
stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
faker_config | False | None | Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly). |
faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
flattening_max_depth | False | None | The max depth to flatten schemas. |
batch_config | False | None | |
batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
batch_config.encoding.format | False | None | Format to use for batch files. |
batch_config.encoding.compression | False | None | Compression format to use for batch files. |
batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
batch_config.storage.root | False | None | Root path to use when writing batch files. |
batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
A full list of supported settings and capabilities for this tap is available by running:
tap-clari --about
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.
You can easily run tap-clari
by itself or in a pipeline using Meltano.
tap-clari --version
tap-clari --help
tap-clari --config CONFIG --discover > ./catalog.json
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-clari
CLI interface directly using poetry run
:
poetry run tap-clari --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-clari
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-clari --version
# OR run a test `elt` pipeline:
meltano elt tap-clari target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.