Teambition是一個(gè)跨平臺(tái)的團(tuán)隊(duì)協(xié)作和項(xiàng)目管理工具胶逢，相當(dāng)于國外的Trello菠净。使用Teambition可以像使用白板與便簽紙一樣來管理項(xiàng)目進(jìn)度，如下圖所示量淌。
Teambition雖然便于管理項(xiàng)目恕汇，但是如果直接在Teambition上面創(chuàng)建一個(gè)項(xiàng)目對應(yīng)的任務(wù)梳毙，卻容易陷入面對茫茫白板徙赢，不知道如何拆分任務(wù)的尷尬境地鸡挠。如下圖所示廊勃。
面對這個(gè)空蕩蕩的窗口懈贺，應(yīng)該添加哪些任務(wù)進(jìn)去？直接用腦子現(xiàn)想坡垫，恐怕容易出現(xiàn)顧此失彼或者干脆漏掉了任務(wù)的情況梭灿。
當(dāng)我要開始一個(gè)項(xiàng)目的時(shí)候，我一般不會(huì)直接打開Teambition就寫任務(wù)冰悠，而是使用一個(gè)大綱工具——Workflowy來梳理思路堡妒，切分任務(wù)。等任務(wù)已經(jīng)切分好了溉卓，在謄寫到Teambition中皮迟，如下圖所示搬泥。
但這樣就出現(xiàn)了一個(gè)問題：首先在Workflowy上面把需要做的任務(wù)寫好。然后再打開Teambition伏尼，把這些任務(wù)又謄寫到Teambition中忿檩。為了減少“謄寫”這一步重復(fù)勞動(dòng)，于是就有了TeamFlowy這個(gè)小工具爆阶。它的作用是自動(dòng)謄寫Workflowy中的特定條目到Teambition中燥透。
功能介紹
TeamFlowy是一個(gè)Python腳本，運(yùn)行以后辨图，它會(huì)登錄Workflowy賬號班套，讀取上面所有的條目。名為[Teambition]的條目是任務(wù)開始的標(biāo)記故河，這個(gè)條目下面的一級條目會(huì)作為任務(wù)被添加到Teambition中吱韭。如果任務(wù)下面還有二級條目，這些二級條目會(huì)作為子任務(wù)被添加到任務(wù)中鱼的。由于Teambition是按照項(xiàng)目-Stage-任務(wù)-子任務(wù)的形式組織一個(gè)工程（其中Stage對應(yīng)了Teambition中工程下面的面板理盆，例如：“待處理”，“進(jìn)行中”鸳吸，“完成”熏挎。）不會(huì)存在子任務(wù)的子任務(wù)，所以Workflowy中[Teambition]這個(gè)條目下面最多出現(xiàn)二級縮進(jìn)晌砾。如下圖所示坎拐。
實(shí)現(xiàn)原理
Workflowy
獲取Workflowy上面的條目，需要進(jìn)行三步操作：
- 登錄Workflowy
- 獲取所有條目對應(yīng)的JSON字符串
- 提取需要添加到Teambition中的條目
登錄Workflowy
打開Chrome監(jiān)控登錄Wokrflowy的過程养匈，可以看到登錄Workflowy需要訪問的接口為：https://workflowy.com/accounts/login/哼勇。使用HTTP POST方式發(fā)送請求，提交的數(shù)據(jù)包括username呕乎，password和一個(gè)不知道用途的next积担。如下圖所示。
使用Python的第三方網(wǎng)絡(luò)模塊requests向這個(gè)模塊發(fā)送POST請求猬仁，提交用戶名和密碼即可實(shí)現(xiàn)登錄帝璧。其代碼如下：
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會(huì)被自動(dòng)保存到session這個(gè)對象里面湿刽。于是使用session繼續(xù)訪問Workfowy就可以以登錄后的身份查看自己的各個(gè)條目的烁。
通過Chrome可以看到獲取所有條目的接口為https://workflowy.com/get_initialization_data?client_version=18，接口返回的數(shù)據(jù)是一個(gè)包含所有條目的超大型JSON字符串诈闺，如下圖所示渴庆。
使用Python的json模塊可以解析這個(gè)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', [])
提取任務(wù)與子任務(wù)
所有的條目層層嵌套在列表-字典結(jié)構(gòu)中襟雷，其基本的形態(tài)如下：
{
"ch": [子條目],
"lm": 308496,
"id": "957996b9-67ce-51c7-a796-bfbee44e3d3f",
"nm": "AutoEmo"
}
其中的nm為這個(gè)條目的名字刃滓。如果一個(gè)條目有子條目，那么ch列表中就會(huì)有很多個(gè)字典耸弄，每個(gè)字典的都是這個(gè)結(jié)構(gòu)咧虎，如果一個(gè)條目沒有子條目，那么就沒有ch這個(gè)key计呈。這樣一層一層嵌套下去：
{
"ch": [
{
"lm": 558612,
"id": "5117e20b-25ba-ba91-59e1-790c0636f78e",
"nm": "準(zhǔn)備并熟背一段自我介紹老客，在任何需要自我介紹的場合都有用"
},
{
"lm": 558612,
"id": "4894b23e-6f47-8028-a26a-5fb315fc4e6f",
"nm": "姓名，來自哪里震叮，什么工作",
"ch": [
{"lm": 5435246,
"id": "4894b23e-6f47-8028-a26a-5fbadfasdc4e6f",
"nm": "工作經(jīng)驗(yàn)"}
]
}
],
"lm": 558612,
"id": "ea282a1c-94f3-1a44-c5b3-7907792e9e6e",
"nm": "自我介紹"
}
由于條目和子條目的結(jié)構(gòu)是一樣的，那么就可以使用遞歸來解析每一個(gè)條目鳍鸵。由于需要添加到Teambition的任務(wù)苇瓣，從名為[Teambition]的條目開始，于是可以使用下面這樣一個(gè)函數(shù)來解析：
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中的條目偿乖，運(yùn)行這段函數(shù)以后击罪，得到的結(jié)果為：
{'登錄Workflowy': [], '獲取需要添加到Teambition的內(nèi)容': ['獲取任務(wù)', '獲取子任務(wù)'], '調(diào)試Teambition API': [], '添加任務(wù)到Teambition': []}
Teambition
將任務(wù)添加到Teambition，需要使用Teambition的Python SDK登錄Teambition并調(diào)用API添加任務(wù)贪薪。Teambition的Python SDK在使用OAuth2獲取access_token的時(shí)候有一個(gè)坑媳禁，需要特別注意。
登錄Teambition
設(shè)置Teambition應(yīng)用
Teambition 是使用OAuth2來進(jìn)行權(quán)限驗(yàn)證的画切，所以需要獲取access_token竣稽。
首先打開Teambition的開發(fā)者中心并單擊新建應(yīng)用，如下圖所示霍弹。
應(yīng)用名稱可以隨便寫毫别。創(chuàng)建好應(yīng)用以后，可以看到應(yīng)用的信息典格，需要記錄Client ID和Client Secret岛宦，如下圖所示。
點(diǎn)擊左側(cè)的OAuth2配置耍缴，填寫回調(diào)URL砾肺，如下圖所示。這里的這個(gè)URL其實(shí)使用任何一個(gè)可以訪問的網(wǎng)站的域名都可以防嗡，這里以我的博客地址為例变汪。
使用Python獲取access_token
首先在Python中安裝Teambition的SDK：
pip install teambition
接下來，在Python中獲取授權(quán)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)
代碼運(yùn)行以后本鸣，會(huì)得到一段形如下面這段URL的授權(quán)URL：
https://account.teambition.com/oauth2/authorize?client_id=7bfae080-a8dc-11e7-b543-77a936726657&redirect_uri=https://kingname.info&state=&lang=zh
在電腦瀏覽器中人工訪問這個(gè)URL疫衩，會(huì)出現(xiàn)下面這樣的頁面。
單擊授權(quán)并登錄，可以看到瀏覽器上面的網(wǎng)址變?yōu)樾稳纾?code>https://kingname.info/?code=Pn7ebs4sZh3NYOz2FvVJQ4uu闷煤，此時(shí)童芹，需要記錄code=后面的這一串字符串Pn7ebs4sZh3NYOz2FvVJQ4uu。
接下來就是Teambition的SDK的坑點(diǎn)了鲤拿，根據(jù)Teambition官方文檔的說法假褪，要獲取access_token，只需要如下兩段代碼：
code = 'Pn7ebs4sZh3NYOz2FvVJQ4uu' #前面瀏覽器中的字符串
tb.oauth.fetch_access_token(code)
# 上面的代碼完成授權(quán)近顷，接下來直接使用tb.xxxx就可以操作任務(wù)了生音。
但實(shí)際上，上面這一段代碼一定會(huì)報(bào)錯(cuò)窒升。提示grant invaild缀遍。要解決這個(gè)問題，就必需使用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', '')
此時(shí)得到的access_token是一段非常長的字符串域醇。接下來，重新初始化tb變量：
tb = Teambition(tb_client_id,
tb_client_secret,
access_token=tb_access_token)
初始化以后蓉媳，使用tb這個(gè)變量譬挚，就可以對工程和任務(wù)進(jìn)行各種操作了。
Teambition的簡單使用
要在某個(gè)工程里面創(chuàng)建任務(wù)酪呻，就需要知道工程的ID减宣。首先在Teambition中手動(dòng)創(chuàng)建一個(gè)工程，在瀏覽器中打開工程玩荠，URL中可以看到工程的ID漆腌，如下圖所示。
有了工程ID以后姨蟋，就可以使用下面的代碼創(chuàng)建任務(wù)：
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()根據(jù)工程ID獲得任務(wù)組的ID和待處理這個(gè)面板的ID屉凯，接下來調(diào)用tb.tasks.create()接口添加任務(wù)。從添加任務(wù)返回的信息里面拿到任務(wù)的ID眼溶，再根據(jù)任務(wù)ID悠砚，調(diào)用tb.subtasks.create()添加子任務(wù)ID。
效果測試
上面的代碼實(shí)現(xiàn)了TeamFlowy的基本邏輯堂飞。運(yùn)行TeamFlowy腳本以后灌旧，[Teambition]這個(gè)條目下面的任務(wù)被成功的添加到了Teambition中，如下圖所示绰筛。
將代碼組合起來并進(jìn)行完善枢泰，讓代碼更容易使用，完整的代碼可以查看https://github.com/kingname/TeamFlowy铝噩。完整的代碼運(yùn)行效果如下圖所示衡蚂。
