`tap-readme` 是 ReadMe.com 的 Singer tap，使用 Meltano SDK 为 Singer Taps 构建。
项目描述
tap-readme
Singer tap for ReadMe.com.
使用 Meltano Singer SDK 构建。
功能
目录状态发现关于流映射模式展平批量
设置
| 设置 | 必需的 | 默认值 | 描述 |
|---|---|---|---|
| api_key | True | None | ReadMe.com 的 API Key |
| stream_maps | False | None | 流映射功能的配置对象。更多信息请参阅 Stream Maps。 |
| stream_map_config | False | None | 在映射表达式中使用用户定义的配置值。 |
| faker_config | False | None | 用于映射表达式中 Faker 实例变量 fake 的配置。仅当插件指定 faker 作为附加依赖项（通过 singer-sdk faker 附加或直接）时适用。 |
| flattening_enabled | False | None | 'True' 以启用模式展平并自动扩展嵌套属性。 |
| flattening_max_depth | False | None | 展平模式的最大深度。 |
| batch_config | False | None |
运行 tap-readme --about 可获得支持的所有设置和功能的完整列表。
支持的 Python 版本
- 3.8
- 3.9
- 3.10
- 3.11
- 3.12
源认证和授权
按照官方认证说明获取API密钥。
用法
您可以通过Meltano或单独运行轻松运行tap-readme。
直接执行Tap
tap-readme --version
tap-readme --help
tap-readme --config CONFIG --discover > ./catalog.json
开发者资源
初始化您的开发环境
pipx install hatch
创建和运行测试
运行集成测试
hatch run tests:integration
您也可以直接测试tap-tap-readme CLI界面
hatch run sync:console -- --about --format=json
使用Meltano进行测试
注意：此Tap可在任何Singer环境中工作，且不需要Meltano。此处示例仅为了方便和简化端到端编排场景。
您的项目已附带预创建的自定义meltano.yml项目文件。如果您尚未安装，请继续安装Meltano。
-
安装所有插件
meltano install -
检查提取器是否正常工作
meltano invoke tap-tap-readme --version
-
执行ELT管道
meltano run tap-tap-readme target-jsonl
SDK开发指南
查看开发指南，了解如何使用SDK开发自己的Tap和目标。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
tap_readme-0.0.1a7.tar.gz (13.8 kB 查看哈希值)
构建分发
tap_readme-0.0.1a7-py3-none-any.whl (14.0 kB 查看哈希值)
