Skip to main content

Python tool for generate github summary in multiple formats

Project description


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 …)


To install the latest release from PyPI

$ pip install github-summary

To install the latest development version from GitHub

$ pip install git+git://


Modify ~/ or, for security reason, it is preferable modify ~/ and execute command

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


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": "",
     "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 -s example_projects.json

You can see the generated example in RST format

You can also see the result directely in my personnal website


Version 0.1.2 (2013-12-20)

  • Add graph languages repartions
  • Fix org2JSON
  • Add changelog
  • Add a projects index
  • Change JSON format

Version 0.1.1 (2013-12-16)

  • First version

Project details

Release history Release notifications

This version
History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
github-summary-0.1.2.tar.gz (22.8 kB) Copy SHA256 hash SHA256 Source None Dec 20, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page