`tap-messagebird` 是Messagebird的Singer tap，使用Meltano Singer SDK构建。
项目描述
tap-messagebird
Messagebird tap类。
使用Meltano Singer SDK构建。
功能
目录状态发现关于流映射模式展平
设置
| 设置 | 必需的 | 默认值 | 描述 |
|---|---|---|---|
| api_key | True | None | 用于验证API服务的令牌。测试密钥不支持Conversations，请参阅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 | 从哪个日期开始拉取记录。日期的ISO8601格式，默认为3年前。 |
| stream_maps | False | None | 流映射功能的配置对象。有关更多信息，请参阅流映射。 |
| stream_map_config | False | None | 在映射表达式中使用的用户定义的配置值。 |
| flattening_enabled | False | None | 'True'以启用模式展平并自动展开嵌套属性。 |
| flattening_max_depth | False | None | 展平模式的最大深度。 |
通过运行： tap-messagebird --about 可获得支持的设置和功能的完整列表。
安装
从PyPi安装
pipx install tap-messagebird
使用环境变量配置
此Singer tap将自动导入工作目录中.env文件内的任何环境变量，如果提供了--config=ENV，则配置值将被考虑，如果终端上下文或.env文件中设置了匹配的环境变量。
源认证和授权
请注意，没有生产API密钥，会话无法工作。
用法
您可以通过Meltano（https://meltano.com/）运行tap-messagebird，也可以单独运行或在管道中使用。
直接执行Tap
tap-messagebird --version
tap-messagebird --help
tap-messagebird --config CONFIG --discover > ./catalog.json
开发人员资源
按照以下说明为该项目做出贡献。
初始化您的开发环境
pipx install poetry
poetry install
创建并运行测试
在tap_messagebird/tests子目录中创建测试，然后运行
poetry run pytest
您还可以使用poetry run直接测试tap-messagebird CLI界面
poetry run tap-messagebird --help
使用Meltano测试
注意：此tap在任何Singer环境中都可以工作，无需Meltano。此处提供的示例仅为了方便和简化端到端编排场景。
接下来，安装Meltano（如果您还没有安装）和任何需要的插件
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-messagebird
meltano install
现在您可以使用Meltano进行测试和编排
# Test invocation:
meltano invoke tap-messagebird --version
# OR run a test `elt` pipeline:
meltano elt tap-messagebird target-jsonl
SDK开发指南
请参阅开发指南，了解如何使用SDK开发自己的taps和targets。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
tap_messagebird-0.0.10.tar.gz (9.0 kB 查看哈希)
构建分发
tap_messagebird-0.0.10-py3-none-any.whl (10.2 kB 查看哈希)
