tap-clickup

tap-clickup是ClickUp的Singer tap。Tap是由AutoIDM创建的，仅因为多个社区成员聚集在一起创建了这个tap。查看AutoIDM进行tap/target创建、维护、支持等更多内容！

赞助商

此tap仅因一些令人惊叹的人共同筹资实现而可用。

请注意，某些赞助商可能未在此列出。

想成为赞助商？请联系我们autoidm.com

功能

• 目录
• 状态
• 发现
• 关于
• 流映射
• 模式展平

设置

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

获取API令牌

1. 在 https://app.clickup.com/ 登录
2. 点击屏幕左下角的您的图标
3. 点击我的设置
4. 点击应用（屏幕左下方的“我的应用”子部分下方附近）
5. 屏幕顶部是API令牌。这可以在api_token位置使用。
   • 这是一个个人令牌，使用个人令牌是完全可以的，因为这个tap只为使用数据的业务使用。

Clickup表架构

请注意，最新信息位于tap_clickup/streams.py中。我们将努力保持这些文档更新

团队

• 表名：team
• 描述：团队数据，每个用户可以属于多个团队
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 团队

空间

• 表名：space
• 描述：每个团队有多个空间
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 空间

时间条目

• 表名：time_entries
• 描述：为每个团队提取所有时间条目。目前仅提取最后30天的时间条目，请参阅https://github.com/AutoIDM/tap-clickup/issues/134了解此问题的处理方法！
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 时间条目

文件夹

• 表名：folder
• 描述：每个空间可以有多个文件夹
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 文件夹

文件夹列表

• 表名：folder_list
• 描述：每个文件夹可以有多个列表
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档：文件夹列表

无文件夹列表

• 表名：folderless_list
• 描述：某些列表不存在于文件夹中
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 无文件夹列表

任务模板

• 表名：task_template
• 描述：任务可以根据您能想到的任何原因进行模板化！
• 主键列：id
• 完全或增量复制：完全
• 书签列：updated_at
• 链接到API端点文档： 任务模板

目标

• 表名：goal
• 描述：团队可以为自己设定目标
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 目标

标签

• 表名：tag
• 描述：每个空间可以有多个标签
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 标签

共享层次结构

• 表名：shared_hierarchy
• 描述：返回您有权访问的所有资源，这些资源中您没有权限访问其父资源。例如，如果您有权访问一个共享任务，但没有权限访问其父列表，它将包含在这个请求中。
• 主键列：（没有主键列）
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 共享层次结构

无文件夹列表的自定义字段

• 表名：folderless_customfield
• 描述：每个无文件夹列表都可以关联自定义字段
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 自定义字段

文件夹列表的自定义字段

• 表名：folder_customfield
• 描述：每个文件夹列表都可以关联自定义字段
• 主键列：id
• 完全或增量复制：完全
• 书签列：N/A
• 链接到API端点文档： 自定义字段

任务

• 表名：tasks
• 描述：一些任务不属于任何文件夹。这来自folderless_list端点
• 主键列：id
• 完全或增量复制：增量
• 书签列：date_updated。请注意，api端点date_updated_gt是大于或等于，而不仅仅是大于。
• 链接到API端点文档： 获取任务

其他信息

• 日期以UNIX时间返回
• API限制使用X-RateLimit头

安装

pipx install tap-clickup

用法

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

直接执行Tap

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

开发者资源

模式调试

我们正在等待https://gitlab.com/meltano/sdk/-/issues/299修复，因为我们使用json模式中的refs。在此之前，我们在client.py中解析模式。

有时，调试refs如何解析是有用的。为此，在./schema-parser中有一个脚本，该目录中的README描述了如何运行解析器

不用担心让它变得非常傻瓜，因为我们预计SDK将发布某种类型的修复

初始化您的开发环境

pipx install poetry
poetry install

创建和运行测试

在tap_clickup/tests子目录中创建测试，然后运行

poetry run pytest

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

poetry run tap-clickup --help

使用Meltano进行测试

_注意：此tap可以在任何Singer环境中使用，且不需要Meltano。

安装Meltano（如果您还没有安装）和任何所需的插件

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

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

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

SDK

使用Meltano SDK为Singer Taps和Targets构建。