tap-gmail

tap-gmail 是一个用于 Gmail 的 Singer tap。

使用为 Singer Taps 构建的 Meltano Tap SDK 构建。

安装

pipx install tap-gmail

配置

接受的配置选项

运行以下命令可获取此 tap 支持的设置和功能的完整列表：

tap-gmail --about

使用环境变量进行配置

如果提供 --config=ENV，则此 Singer tap 将自动导入工作目录 .env 内的任何环境变量，这样如果终端上下文或 .env 文件中设置了匹配的环境变量，则将考虑配置值。

源身份验证和授权

用法

您可以使用 Meltano 或单独运行 tap-gmail。

直接执行 Tap

tap-gmail --version
tap-gmail --help
tap-gmail --config CONFIG --discover > ./catalog.json

开发者资源

初始化您的开发环境

pipx install poetry
poetry install

创建和运行测试

在 tap_gmail/tests 子文件夹中创建测试，然后运行

poetry run pytest

您还可以使用 poetry run 直接测试 tap-gmail CLI 界面

poetry run tap-gmail --help

使用 Meltano 进行测试

注意: 此 tap 可在任何 Singer 环境中工作，不需要 Meltano。这里提供的示例是为了方便和简化端到端编排场景。

您的项目已附带自定义的 meltano.yml 项目文件。打开 meltano.yml 并遵循文件中列出的任何 "TODO" 项。

接下来，安装 Meltano（如果尚未安装）和任何需要的插件

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-gmail
meltano install

现在您可以使用 Meltano 进行测试和编排。

# Test invocation:
meltano invoke tap-gmail --version
# OR run a test `elt` pipeline:
meltano elt tap-gmail target-jsonl

SDK 开发指南

查看开发指南，获取如何使用 SDK 开发自己的 taps 和 targets 的更多说明。