Python tool for generate github summary in multiple formats
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
githubsummary
requirements
.gitignore
.travis.yml
CHANGELOG.txt
LICENSE
MANIFEST.in
Makefile
README.rst
coverage.rc
example.rst
example_projects.json
pep8.rc
setup.py
tests.py

README.rst

https://travis-ci.org/badele/github-summary.png?branch=master https://coveralls.io/repos/badele/github-summary/badge.png
.. disableimage:: https://pypip.in/v/github-summary/badge.png
   :target: https://crate.io/packages/github-summary/

.. disableimage:: https://pypip.in/d/github-summary/badge.png
   :target: https://crate.io/packages/github-summary/



About

github-summary is a python tool for generate github summary in multiple formats. It can generate a github summary in multiple formats (RST, TXT, HTML, etc ...)

Installing

To install the latest release from PyPI

$ pip install github-summary

To install the latest development version from GitHub

$ pip install git+git://github.com/badele/github-summary.git

Utilization

Modify ~/.github-summary.py or config.py, for security reason, it is preferable modify ~/.github-summary.py and execute command

githubsummary -t rst/index-en.rst -j example_projects.json -s example.rst

Options

You can configure options by projects, options is stored in JSON format. Here an exemple of JSON options

{
 "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"
 }
}

You can also use the externals tools for populate the JSON file. Ex: Emacs Org file to JSON file (projects contributed time)

org2json -o project.org -s example_projects.json

You can see the generated example in RST format

http://bruno.adele.im/static/github-summary.png

You can also see the result directely in my personnal website