這個工具是專為 talk vTaiwan 所開發。
目的是當 talk vTaiwan 的法案建立 gitbook 後要據其內容在討論區建立對應的問題。vTaiwan 的 gitbook 會建立在 g0v 的 gihub repo 例如企業資產擔保法草案。
整個流程首先會根據對應法案的 g0v repo 去取得 packeage.json 法案名稱與 SUMMARY.md 與以及對應的 .md 檔案內容。
package.json:gitbook相關設定，用其來建立討論區分類法案的中文名稱。SUMMARY.md:gitbook大綱，用他取得子分類名稱與對應的內容。
- clone repo 到本機端並且安裝 (支援 Python2.7, Python3.x)
git clone https://github.com/chairco/vtdiscourse.git`
- 安裝套件
cd vtdiscourse
python setup.py install
分成兩種，一種是安裝後透過 command line 一鍵完成。第二種則是撰寫一個簡單的 script 來完成。
- 取得法案名稱方法
vtd -n "api_user" -p "api_key" -g "gihub's repo name" -s GET
- 建立 talk.vTaiwan 討論內容
vtd -n "api_user" -p "api_key" -g "gihub's repo name" -s DEPLOY
請注意某些內容必須要有管理員權限的 API-User, API-Key 才能存取。
>>> discourse = Discourse(
url = 'https://talk.vtaiwan.tw',
api_username='使用者',
api_key='金鑰')
- 設定參數檔案、讀取 github 的檔案名稱
>>> parm = Parser(name='directors-election-gitbook', githubfile='package.json')
- 抓取法案的中文名稱
>>> print(parm.get_name)
-
尚未建立物件時，直接設定物件參數
parm = Parser(name='directors-election-gitbook', githubfile='SUMMARY.md') -
已經建立物件
parm = Parser(name='directors-election-gitbook', githubfile='package.json')，直接透過setter方法parm.githubfile = "SUMMARY.md"轉為讀取SUMMARY.md
>>> print(parm.get_topics_content) # Get SUMMARY.md content
進入專案內資料夾內執行 py.test
MIT LICENSE