Teambition是一個跨平台的團隊協作和項目管理工具,相當於國外的Trello。使用Teambition可以像使用白板與便簽紙一樣來管理項目進度,如下圖所示。
Teambition雖然便於管理項目,但是如果直接在Teambition上面創建一個項目對應的任務,卻容易陷入面對茫茫白板,不知道如何拆分任務的尷尬境地。如下圖所示。
面對這個空盪盪的窗口,應該添加哪些任務進去?直接用腦子現想,恐怕容易出現顧此失彼或者干脆漏掉了任務的情況。
當我要開始一個項目的時候,我一般不會直接打開Teambition就寫任務,而是使用一個大綱工具——Workflowy來梳理思路,切分任務。等任務已經切分好了,在謄寫到Teambition中,如下圖所示。
但這樣就出現了一個問題:首先在Workflowy上面把需要做的任務寫好。然后再打開Teambition,把這些任務又謄寫到Teambition中。為了減少“謄寫”這一步重復勞動,於是就有了TeamFlowy這個小工具。它的作用是自動謄寫Workflowy中的特定條目到Teambition中。
功能介紹
TeamFlowy是一個Python腳本,運行以后,它會登錄Workflowy賬號,讀取上面所有的條目。名為[Teambition]的條目是任務開始的標記,這個條目下面的一級條目會作為任務被添加到Teambition中。如果任務下面還有二級條目,這些二級條目會作為子任務被添加到任務中。由於Teambition是按照項目-Stage-任務-子任務的形式組織一個工程(其中Stage對應了Teambition中工程下面的面板,例如:“待處理”,“進行中”,“完成”。)不會存在子任務的子任務,所以Workflowy中[Teambition]這個條目下面最多出現二級縮進。如下圖所示。
實現原理
Workflowy
獲取Workflowy上面的條目,需要進行三步操作:
- 登錄Workflowy
- 獲取所有條目對應的JSON字符串
- 提取需要添加到Teambition中的條目
登錄Workflowy
打開Chrome監控登錄Wokrflowy的過程,可以看到登錄Workflowy需要訪問的接口為:https://workflowy.com/accounts/login/
。使用HTTP POST
方式發送請求,提交的數據包括username
,password
和一個不知道用途的next
。如下圖所示。
使用Python的第三方網絡模塊requests
向這個模塊發送POST
請求,提交用戶名和密碼即可實現登錄。其代碼如下:
login_url = 'https://workflowy.com/accounts/login/'
session = requests.Session()
session.post(login_url,
data={'username': '12345@qq.com',
'password': '8888888',
'next': ''})
獲取所有條目
使用requests
的session
登錄Workflowy以后,Cookies會被自動保存到session
這個對象里面。於是使用session
繼續訪問Workfowy就可以以登錄后的身份查看自己的各個條目。
通過Chrome可以看到獲取所有條目的接口為https://workflowy.com/get_initialization_data?client_version=18
,接口返回的數據是一個包含所有條目的超大型JSON字符串,如下圖所示。
使用Python的json模塊可以解析這個JSON字符串為字典,並獲取所有條目,代碼如下:
outline_url = 'https://workflowy.com/get_initialization_data?client_version=18'
outlines_json = session.get(outline_url).text
outlines_dict = json.loads(outlines_json)
project_list = outlines_dict.get('projectTreeData', {})\
.get('mainProjectTreeInfo', {})\
.get('rootProjectChildren', [])
提取任務與子任務
所有的條目層層嵌套在列表-字典結構中,其基本的形態如下:
{
"ch": [子條目],
"lm": 308496,
"id": "957996b9-67ce-51c7-a796-bfbee44e3d3f",
"nm": "AutoEmo"
}
其中的nm
為這個條目的名字。如果一個條目有子條目,那么ch
列表中就會有很多個字典,每個字典的都是這個結構,如果一個條目沒有子條目,那么就沒有ch
這個key。這樣一層一層嵌套下去:
{
"ch": [
{
"lm": 558612,
"id": "5117e20b-25ba-ba91-59e1-790c0636f78e",
"nm": "准備並熟背一段自我介紹,在任何需要自我介紹的場合都有用"
},
{
"lm": 558612,
"id": "4894b23e-6f47-8028-a26a-5fb315fc4e6f",
"nm": "姓名,來自哪里,什么工作",
"ch": [
{"lm": 5435246,
"id": "4894b23e-6f47-8028-a26a-5fbadfasdc4e6f",
"nm": "工作經驗"}
]
}
],
"lm": 558612,
"id": "ea282a1c-94f3-1a44-c5b3-7907792e9e6e",
"nm": "自我介紹"
}
由於條目和子條目的結構是一樣的,那么就可以使用遞歸來解析每一個條目。由於需要添加到Teambition的任務,從名為[Teambition]的條目開始,於是可以使用下面這樣一個函數來解析:
task_dict = {}
def extract_task(sections, task_dict, target_section=False):
for section in sections:
name = section['nm']
if target_section:
task_dict[name] = [x['nm'] for x in section.get('ch', [])]
continue
if name == '[Teambition]':
target_section = True
sub_sections = section.get('ch', [])
extract_task(sub_sections, task_dict, target_section=target_section)
下圖所示為一段需要添加到Teambition中的條目,運行這段函數以后,得到的結果為:
{'登錄Workflowy': [], '獲取需要添加到Teambition的內容': ['獲取任務', '獲取子任務'], '調試Teambition API': [], '添加任務到Teambition': []}
Teambition
將任務添加到Teambition,需要使用Teambition的Python SDK登錄Teambition並調用API添加任務。Teambition的Python SDK在使用OAuth2
獲取access_token
的時候有一個坑,需要特別注意。
登錄Teambition
設置Teambition應用
Teambition 是使用OAuth2
來進行權限驗證的,所以需要獲取access_token
。
首先打開Teambition的開發者中心並單擊新建應用
,如下圖所示。
應用名稱可以隨便寫。創建好應用以后,可以看到應用的信息,需要記錄Client ID
和Client Secret
,如下圖所示。
點擊左側的OAuth2
配置,填寫回調URL,如下圖所示。這里的這個URL其實使用任何一個可以訪問的網站的域名都可以,這里以我的博客地址為例。
使用Python獲取access_token
首先在Python中安裝Teambition的SDK:
pip install teambition
接下來,在Python中獲取授權URL:
from teambition import Teambition
tb_client_id = '7bfae080-a8dc-11e7-b543-77a936726657'
tb_client_secret = '9830fc8c-81b3-45ed-b3c0-e039ab8f2d8b'
tb = Teambition(tb_client_id,
tb_client_secret)
authorize_url = tb.oauth.get_authorize_url('https://kingname.info')
print(authorize_url)
代碼運行以后,會得到一段形如下面這段URL的授權URL:
https://account.teambition.com/oauth2/authorize?client_id=7bfae080-a8dc-11e7-b543-77a936726657&redirect_uri=https://kingname.info&state=&lang=zh
在電腦瀏覽器中人工訪問這個URL,會出現下面這樣的頁面。
單擊授權並登錄
,可以看到瀏覽器上面的網址變為形如:https://kingname.info/?code=Pn7ebs4sZh3NYOz2FvVJQ4uu
,此時,需要記錄code=
后面的這一串字符串Pn7ebs4sZh3NYOz2FvVJQ4uu
。
接下來就是Teambition的SDK的坑點了,根據Teambition官方文檔的說法,要獲取access_token,只需要如下兩段代碼:
code = 'Pn7ebs4sZh3NYOz2FvVJQ4uu' #前面瀏覽器中的字符串
tb.oauth.fetch_access_token(code)
# 上面的代碼完成授權,接下來直接使用tb.xxxx就可以操作任務了。
但實際上,上面這一段代碼一定會報錯。提示grant invaild
。要解決這個問題,就必需使用Teambition的HTTP 接口來人工獲取access_token。
code = 'Pn7ebs4sZh3NYOz2FvVJQ4uu' #前面瀏覽器中的字符串
fetch_result_dict = session.post('https://account.teambition.com/oauth2/access_token',
data={'client_id': tb_client_id,
'client_secret': tb_client_secret,
'code': code,
'grant_type': 'code'}).json()
tb_access_token = fetch_result_dict.get('access_token', '')
此時得到的access_token是一段非常長的字符串。接下來,重新初始化tb變量:
tb = Teambition(tb_client_id,
tb_client_secret,
access_token=tb_access_token)
初始化以后,使用tb這個變量,就可以對工程和任務進行各種操作了。
Teambition的簡單使用
要在某個工程里面創建任務,就需要知道工程的ID。首先在Teambition中手動創建一個工程,在瀏覽器中打開工程,URL中可以看到工程的ID,如下圖所示。
有了工程ID以后,就可以使用下面的代碼創建任務:
def create_task(task_name, sub_task_list):
tasklist = tb.tasklists.get(project_id='59d396ee1013d919f3348675')[0]
tasklist_id = tasklist['_id']
todo_stage_id = tasklist['stageIds'][0]
task_info = tb.tasks.create(task_name, tasklist_id=tasklist_id, stage_id=todo_stage_id)
if sub_task_list:
task_id = task_info['_id']
for sub_task_name in sub_task_list:
tb.subtasks.create(sub_task_name, task_id=task_id)
print(f'task: {task_name} with sub tasks: {sub_task_list} added.')
這段代碼首先使用tb.tasklists.get()
根據工程ID獲得任務組的ID和待處理
這個面板的ID,接下來調用tb.tasks.create()
接口添加任務。從添加任務返回的信息里面拿到任務的ID,再根據任務ID,調用tb.subtasks.create()
添加子任務ID。
效果測試
上面的代碼實現了TeamFlowy的基本邏輯。運行TeamFlowy腳本以后,[Teambition]這個條目下面的任務被成功的添加到了Teambition中,如下圖所示。
將代碼組合起來並進行完善,讓代碼更容易使用,完整的代碼可以查看https://github.com/kingname/TeamFlowy。完整的代碼運行效果如下圖所示。