TeamFlowy——結合Teambition與Workflowy提升生產力

Teambition是一個跨平臺的團隊協做和項目管理工具,至關於國外的Trello。使用Teambition能夠像使用白板與便籤紙同樣來管理項目進度,以下圖所示。python

Teambition雖然便於管理項目,可是若是直接在Teambition上面建立一個項目對應的任務,卻容易陷入面對茫茫白板,不知道如何拆分任務的尷尬境地。以下圖所示。git

面對這個空蕩蕩的窗口,應該添加哪些任務進去?直接用腦子現想,恐怕容易出現顧此失彼或者乾脆漏掉了任務的狀況。github

當我要開始一個項目的時候,我通常不會直接打開Teambition就寫任務,而是使用一個大綱工具——Workflowy來梳理思路,切分任務。等任務已經切分好了,在謄寫到Teambition中,以下圖所示。json

但這樣就出現了一個問題:首先在Workflowy上面把須要作的任務寫好。而後再打開Teambition,把這些任務又謄寫到Teambition中。爲了減小「謄寫」這一步重複勞動,因而就有了TeamFlowy這個小工具。它的做用是自動謄寫Workflowy中的特定條目到Teambition中。瀏覽器

功能介紹

TeamFlowy是一個Python腳本,運行之後,它會登陸Workflowy帳號,讀取上面全部的條目。名爲[Teambition]的條目是任務開始的標記,這個條目下面的一級條目會做爲任務被添加到Teambition中。若是任務下面還有二級條目,這些二級條目會做爲子任務被添加到任務中。因爲Teambition是按照項目-Stage-任務-子任務的形式組織一個工程(其中Stage對應了Teambition中工程下面的面板,例如:「待處理」,「進行中」,「完成」。)不會存在子任務的子任務,因此Workflowy中[Teambition]這個條目下面最多出現二級縮進。以下圖所示。bash

實現原理

Workflowy

獲取Workflowy上面的條目,須要進行三步操做:網絡

  1. 登陸Workflowy
  2. 獲取全部條目對應的JSON字符串
  3. 提取須要添加到Teambition中的條目

登陸Workflowy

打開Chrome監控登陸Wokrflowy的過程,能夠看到登陸Workflowy須要訪問的接口爲:https://workflowy.com/accounts/login/。使用HTTP POST方式發送請求,提交的數據包括usernamepassword和一個不知道用途的next。以下圖所示。session

使用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': ''})複製代碼

獲取全部條目

使用requestssession登陸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 IDClient 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中,以下圖所示。

將代碼組合起來並進行完善,讓代碼更容易使用,完整的代碼能夠查看github.com/kingname/Te…。完整的代碼運行效果以下圖所示。

相關文章
相關標籤/搜索