用于以多种格式生成github摘要的python工具
github-summar的Python项目详细描述
关于
github-summary是一个python工具,用于以多种格式生成github摘要。它可以以多种格式(rst、txt、html等)生成github摘要
安装
从PyPI安装最新版本
$ pip install github-summary安装最新的开发版本
$ pip install git+git://github.com/badele/github-summary.git
利用率
修改~/.github-summary.py或config.py,出于安全原因,最好修改~/.github-summary.py并执行命令
githubsummary -t rst/index-en.rst -j example_projects.json -s example.rst
选项
您可以按项目配置选项,选项以json格式存储。下面是一个json选项的示例
{ "fabrecipes": { "hours": "89", "description": "A overwriting description text for fabrecipe." }, "JobCatcher": { "hours": "108", "description": "Another overwriting description text for JobCatcher." }, "gitcheck": { "hours": "15", "url": "http://bruno.adele.im/projets/gitcheck", "description": "Check multiple git repository in one pass." }, "github-summary": { "coveralls": "True", "description": "Python tool for generate github summary in multiple formats (TXT, RST, HTML, ...)", "pypi": "True", "pydownload": "True", "hours": "30", "travis": "True" } }
您还可以使用externals工具填充json文件。例如:emacs org文件到json文件(项目贡献时间)
org2json -o project.org -s example_projects.json
您可以在rst格式中看到生成的example
你也可以直接在我的个人主页上看到结果website
更改日志
版本0.1.2(2013-12-20)
- 添加图形语言重新分区
- 修复org2json
- 添加更改日志
- 添加项目索引
- 更改JSON格式
版本0.1.1(2013-12-16)
- 第一个版本