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中