`tap-messagebird` is a Singer tap for Messagebird, built with the Meltano Singer SDK.
Project description
tap-messagebird
Messagebird tap class.
Built with the Meltano Singer SDK.
Capabilities
catalog
state
discover
about
stream-maps
schema-flattening
Settings
Setting | Required | Default | Description |
---|---|---|---|
api_key | True | None | The token to authenticate against the API service. Test keys are not supported for Conversations see https://support.messagebird.com/hc/en-us/articles/360000670709-What-is-the-difference-between-a-live-key-and-a-test-key- |
start_date | False | now -3 years | When to pull records starting at what date. ISO8601 format of date, defaults to 3 years ago. |
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. |
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. |
A full list of supported settings and capabilities is available by running: tap-messagebird --about
Installation
Install from PyPi:
pipx install tap-messagebird
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
Note that Conversations do not work without a Production API key
Usage
You can easily run tap-messagebird
by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-messagebird --version
tap-messagebird --help
tap-messagebird --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_messagebird/tests
subfolder and
then run:
poetry run pytest
You can also test the tap-messagebird
CLI interface directly using poetry run
:
poetry run tap-messagebird --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-messagebird
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-messagebird --version
# OR run a test `elt` pipeline:
meltano elt tap-messagebird 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_messagebird-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c8dc2d636a0608c2f9dab45af04ab587af3fa27a353a3b78c6434a922d8554c |
|
MD5 | 589492fb253d95d2d1e6172fd07b4da1 |
|
BLAKE2b-256 | 56b032042ae68e838219d402f70d4e7b7be48f2312ea2b066481581c1934d330 |