ClickUp、clickupython

news2024/11/17 5:52:05

文章目录

- 关于 ClickUp
- 关于 clickupython
- 安装
- Authentication
- 方法 1: API Key (最快)
- 当前 ClickUpClient 功能
- - Task
  - List
  - Folder
  - Attachments
  - Comments
  - Teams
  - Checklists
  - Goals
  - Members
  - Tags
  - Spaces
  - Time Tracking
- 教程

关于 ClickUp

官网：https://clickup.com/
University Courses : https://university.clickup.com/page/course-catalog

成希 - 40亿美金的项目管理独角兽ClickUp与国内的模仿者
https://zhuanlan.zhihu.com/p/626747417
随机小分队 - 火车司机如何打造40亿美金SaaS火箭？带你回顾PLG卷王ClickUp的前世今生
https://www.woshipm.com/chuangye/5665109.html
ClickUp项目工具-指数级提升你的工作效率
https://mp.weixin.qq.com/s/bnvdHp6M1g454drk8z8eaA
在红海赛道 6 年做到 1.5 亿 ARR，ClickUp 做对了什么？
https://mp.weixin.qq.com/s/6bbmivmUfKfB7U85Z8r6kg

ClickUp 是一款 GTD 工具。
GTD是 “Getting Things Done” 的缩写，是由效率管理专家戴维·艾伦（David Allen）开创的一套完整个人时间管理系统。
GTD，中文称为“搞定”。我感觉也可以称为 “成事”。

ClickUp 成立于2017年，创始人是 Zeb Evans。

ClickUp的产品结构

ClickUp包含以下这些功能，用户可以随意创建功能的组合

任务列表
看板
白板
表格
聊天
文档
文件管理
甘特图
时间线
日历
思维导图
能效度量

但不同于Notion的功能以“块”为单位，ClickUp的功能是以“页面”为单位。

并且ClickUp更强调工作空间“Space”的灵活性。
我们用Notion可能创建2-3个工作空间，就足够了，但是你可能在ClickUp里可能会创建10个甚至20个空间。

下图，就是ClickUp的逻辑。Space下的list 就是“功能页”的组合。List又可以被文件夹进行树形结构化的管理。
不同于Jira这类产品，ClickUp更强调你自己用功能去组织自己的管理。

在这里插入图片描述

关于 clickupython

A client for working with the ClickUp API V2

github : https://github.com/Imzachjohnson/clickupython
文档：https://clickupython.readthedocs.io

clickupython is a Python client for the ClickUp API and can be used to interact with the ClickUp API in your projects.

ClickUp’s API exposes the entire ClickUp infrastructure via a standardized programmatic interface.

Using ClickUp’s API, you can do just about anything you can do on clickup.com.

安装

pip install clickupython

Authentication

有两种方式使用 ClickUp API 2.0，使用个人 token 或者创建应用使用 OAuth2 flow 授权。

如果你想创建一个app给其他人用，强烈建议你使用 OAuth2 flow。

方法 1: API Key (最快)

登入 ClickUp，进入 Settings > Apps 页面，你将看到 API token，复制保存。

from clickupython import client

API_KEY = 'YOUR API KEY'
client = ClickUpClient(API_KEY)

# Example request | Creating a task in a list
c = client.ClickUpClient(API_KEY)
task = c.create_task("list_id", name="Test task", due_date="march 2 2021")

print(task.name)

if task:
	print(task.id)

当前 ClickUpClient 功能

Task

get_task(task_id)
get_tasks(list_id, archived, page, order_by, reverse, subtasks, statuses, include_closed, assignees, due_date_gt, due_date_lt, date_created_gt, date_created_lt, date_updated_gt, date_updated_lt)
create_task(list_id, name, description, priority, assignees, tags, status, due_date, start_date, notify_all)
update_task(task_id, name, description, status, priority, time_estimate, archived, add_assignees,remove_assignees

List

get_list(list_id)
get_lists(folder_id)
create_list(folder_id, name, content, due_date, priority, status)
create_folderless_list(space_id, name, content, due_date, priority, assignee, status)
update_list(list_id, name, content, due_date, due_date_time, priority, assignee, unset_status)
delete_list(list_id)
add_task_to_list(task_id, list_id)
remove_task_from_list(task_id, list_id)

Folder

get_folder(folder_id)
get_folders(space_id)
create_folder(space_id, name)
update_folder(folder_id, name)
delete_folder(folder_id)

Attachments

upload_attachment(task_id, file_path)

Comments

get_task_comments(task_id)
get_list_comments(list_id)
get_chat_comments(view_id)
update_comment(comment_id)
delete_comment(comment_id)
create_task_comment(task_id)

Teams

get_teams()

Checklists

create_checklist(task_id, name)
create_checklist_item(checklist_id, name, assignee)
delete_checklist_item(checklist_id, checklist_item_id)
update_checklist_item(checklist_id, checklist_item_id, name, resolved, parent)

Goals

create_goal(team_id, name, due_date, description, multiple_owners, owners, color)
update_goal(goal_id, name, due_date, description, rem_owners, add_owners, color)
delete_goal(goal_id)
get_goal(goal_id)
get_goals(team_id, include_completed)

Members

get_task_members(task_id)
get_list_members(list_id)

Spaces

create_space(team_id, name, features)
delete_space(space_id)
get_space(space_id)
get_spaces( team_id, archived)

Time Tracking

get_time_entries_in_range(team_id, start_date, end_date, assignees)
get_single_time_entry(team_id, timer_id)
start_timer(team_id, timer_id)
stop_timer(team_id)

教程

clickupython
- Getting started
- Authentication
Tasks
- Task
- Creating a Task
- Fetching a Single Task
- Fetching all Tasks from a List
- Filtering Tasks
- Working With Tasks
- Getting Tasks Associated with a List Object
- Task Methods
Lists
- SingleList
- Creating a List
- Fetching a Single Task
- Fetching all Tasks from a List
- Filtering Tasks
- Working With Tasks
- Getting Tasks Associated with a List Object
- List Methods