Okydoky

Okydoky是使用獅身人面像，分發和GitHub的（這是setuptools的）＆NBSP自動化的文檔生成器，它使你的封閉Python項目，不斷建立文檔，與以下假設：
1.文檔是使用獅身人面像。
2.項目是通過setuptools的包裝（而不是點子，也沒有任何其他人）。
3.源代碼在GitHub的管理。
不久說，這是一個簡單的ReadTheDocs.org供私人使用。
工作原理
它工作在以下說明：
1.當新的提交推，GitHub的觸發Okydoky後收到鉤。
2. Okydoky下載壓縮包，從GitHub上推提交的檔案。
3. tar包檔案被解壓縮到一個臨時目錄。
4.獅身人面像建造的文檔。
5.當用戶要求使用他們的網絡瀏覽器的文檔，Okydoky要求用戶使用GitHub的OAuth的認證。
6.如果有授權，Okydoky提供一個內置的文檔。
如何使用
這是一個普通的Python包。你可以使用easy_install的安裝：
＆NBSP; easy_install的Okydoky
這個包提供了一個名為okydoky命令行腳本。這是一個Web應用程序，也是一個小型的Web服務器本身。它需要一個配置文件。
配置文件必須包含類似GitHub的應用程序鍵和秘密密鑰一些所需的值。
你必須創建一個GitHub的應用程序使用Okydoky。其回調URL是非常重要的。它填補：
HTTP：// <主機> /認證/敲定
並取代<主持人>你會使用什麼樣的域名。然後，添加後收到鉤到你的GitHub庫：
HTTP：// <主機> /
如果你犯了一個配置文件，然​​後使用okydoky腳本運行Okydoky服務器：
＆NBSP; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
最後，你必須做出一個初步的auth完成安裝。打開http：// <主機> /在你的網頁瀏覽器，並從那裡與GitHub上登錄。
配置
配置文件是一個普通的Python腳本。它採用瓶的配置系統。閱讀瓶的文檔有關的配置文件。
REPOSITORY
＆NBSP;用戶和存儲庫的名稱如“crosspop / okydoky”。
CLIENT_ID
＆NBSP;在GitHub上應用程序的客戶端密鑰。
CLIENT_SECRET
＆NBSP;在GitHub上應用程序的密鑰。
SAVE_DIRECTORY
＆NBSP;存儲數據的目錄的路徑。該目錄將存儲一些配置數據，壓縮包，並內置單證。
SECRET_KEY
＆NBSP;該密鑰簽名會。見瓶的文檔有關會話也。
打開來源
Okydoky寫的是香港Minhee的Crosspop。它根據MIT許可證分發，源代碼可以在GitHub的庫中找到。查看：
＆NBSP;混帳混帳克隆：//github.com/crosspop/okydoky.git

什麼在此版本中是新的：

• GitHub的強制狀態的OAuth。遵循這一點。

什麼在0.9.4版本新：

• 使用--upgrade選項setup.py發展命令。這樣可以防止依賴的版本衝突。
• 在構建日誌留在build.txt文件。

什麼版本0.9.3的新：

• 現在，索引頁顯示裁判的名單。
• 現在，Okydoky套在其構建過程中OKYDOKY = 1環境變量。 [＃5]
• 添加/頭特殊的參考網址。
• 修正了頭未設置為最新的一個bug提交。

什麼在0.9.2版本新：

• 修正了一個安全漏洞：現在用戶必須有一個授權存儲庫。 [＃4]

要求：

• 在Python中