Metadata-Version: 1.1
Name: github-summary
Version: 0.1.2
Summary: Python tool for generate github summary in multiple formats
Home-page: https://github.com/badele/github-summary
Author: Bruno Adelé
Author-email: bruno@adele.im
License: GPL
Description: 
        
        
        
        
        
        
        
        
        
        
        
        
        
        
        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 <http://pypi.python.org/pypi/github-summary>`_
        
        ::
        
            $ pip install github-summary
        
        To install the latest development version from `GitHub <https://github.com/badele/github-summary>`_
        
        ::
        
            $ 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 <https://github.com/badele/github-summary/blob/master/example.rst>`_ in RST format
        
        
        
        You can also see the result directely in my personnal `website <http://bruno.adele.im>`_ 
        
        Changelog
        =========
        
        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
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
