| Name | tap-messagebird JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | |
| Summary | `tap-messagebird` is a Singer tap for Messagebird, built with the Meltano Singer SDK. |
| upload_time | 2023-07-07 17:32:39 |
| maintainer | |
| docs_url | None |
| author | Meltano Team |
| requires_python | >=3.7.1,<3.11 |
| license | Apache 2.0 |
| keywords |
elt
messagebird
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `tap-messagebird`
Messagebird tap class.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## 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](https://sdk.meltano.com/en/latest/stream_maps.html). |
| 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:
```bash
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](https://meltano.com/).
### Executing the Tap Directly
```bash
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
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_messagebird/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-messagebird` CLI interface directly using `poetry run`:
```bash
poetry run tap-messagebird --help
```
### Testing with [Meltano](https://www.meltano.com)
_**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:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-messagebird
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# 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](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": "",
"name": "tap-messagebird",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.11",
"maintainer_email": "",
"keywords": "ELT,Messagebird",
"author": "Meltano Team",
"author_email": "hello@meltano.com",
"download_url": "https://files.pythonhosted.org/packages/65/30/bfc4420b8e236702b623810f073d4f6913b625af63589921085dc64d8c81/tap_messagebird-0.0.10.tar.gz",
"platform": null,
"description": "# `tap-messagebird`\n\nMessagebird tap class.\n\nBuilt with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| 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- |\n| start_date | False | now -3 years | When to pull records starting at what date. ISO8601 format of date, defaults to 3 years ago. |\n| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth| False | None | The max depth to flatten schemas. |\n\nA full list of supported settings and capabilities is available by running: `tap-messagebird --about`\n\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-messagebird\n```\n\n\n### Configure using environment variables\n\nThis Singer tap will automatically import any environment variables within the working directory's\n`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching\nenvironment variable is set either in the terminal context or in the `.env` file.\n\n### Source Authentication and Authorization\n\nNote that Conversations do not work without a Production API key\n\n## Usage\n\nYou can easily run `tap-messagebird` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-messagebird --version\ntap-messagebird --help\ntap-messagebird --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\nFollow these instructions to contribute to this project.\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tap_messagebird/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-messagebird` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-messagebird --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-messagebird\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-messagebird --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-messagebird target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "`tap-messagebird` is a Singer tap for Messagebird, built with the Meltano Singer SDK.",
"version": "0.0.10",
"project_urls": null,
"split_keywords": [
"elt",
"messagebird"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56b032042ae68e838219d402f70d4e7b7be48f2312ea2b066481581c1934d330",
"md5": "589492fb253d95d2d1e6172fd07b4da1",
"sha256": "9c8dc2d636a0608c2f9dab45af04ab587af3fa27a353a3b78c6434a922d8554c"
},
"downloads": -1,
"filename": "tap_messagebird-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "589492fb253d95d2d1e6172fd07b4da1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.11",
"size": 10193,
"upload_time": "2023-07-07T17:32:37",
"upload_time_iso_8601": "2023-07-07T17:32:37.511361Z",
"url": "https://files.pythonhosted.org/packages/56/b0/32042ae68e838219d402f70d4e7b7be48f2312ea2b066481581c1934d330/tap_messagebird-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6530bfc4420b8e236702b623810f073d4f6913b625af63589921085dc64d8c81",
"md5": "46259dc79740415ad98ae9e0771aef31",
"sha256": "9b75220c7a2c24bbfda589f01ae72d8b15e7eb64c37b204f345277f4473eef64"
},
"downloads": -1,
"filename": "tap_messagebird-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "46259dc79740415ad98ae9e0771aef31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.11",
"size": 8963,
"upload_time": "2023-07-07T17:32:39",
"upload_time_iso_8601": "2023-07-07T17:32:39.009328Z",
"url": "https://files.pythonhosted.org/packages/65/30/bfc4420b8e236702b623810f073d4f6913b625af63589921085dc64d8c81/tap_messagebird-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-07 17:32:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-messagebird"
}
