Metadata-Version: 2.4
Name: git2json
Version: 0.2.3
Summary: Convert git logs to JSON for easier analysis.
Home-page: https://github.com/tarmstrong/git2json
Author: Tavish Armstrong
Author-email: tavisharmstrong@gmail.com
License: BSD
Keywords: git2json
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
License-File: LICENSE
License-File: AUTHORS.rst
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: summary

===============================
Git2JSON
===============================

.. image:: https://badge.fury.io/py/git2json.png
    :target: http://badge.fury.io/py/git2json
    
.. image:: https://travis-ci.org/tarmstrong/git2json.png?branch=master
        :target: https://travis-ci.org/tarmstrong/git2json

.. image:: https://pypip.in/d/git2json/badge.png
        :target: https://crate.io/packages/git2json?version=latest


Convert git logs to JSON for easier analysis.

* Free software: BSD license
* Documentation: http://git2json.rtfd.org.

Installation
------------

The easiest way to install ``git2json`` is through pip:

::

    pip install git2json

If you want the most up-to-date version (at a greater risk of encountering
bugs) you can clone this repository and install it manually:

::

    git clone https://github.com/tarmstrong/git2json.git
    cd git2json
    python setup.py install

Usage
-----

::

    usage: git2json [-h] [--git-dir GIT_DIR]

    optional arguments:
      -h, --help         show this help message and exit
      --git-dir GIT_DIR  Path to the .git/ directory of the repository you are
                        targeting


The resulting JSON log is printed to standard output.

Example JSON
------------

The following shows the structure of the JSON emitted by the tool.

::

    [{
        "committer": {
            "date": 1379903278,
            "timezone": "-0400",
            "name": "Tavish Armstrong",
            "email": "tavisharmstrong@gmail.com"
        },
        "parents": ["e307663594031738c932877c8589552d5aafc953"],
        "author": {
            "date": 1379903278,
            "timezone": "-0400",
            "name": "Tavish Armstrong",
            "email": "tavisharmstrong@gmail.com"
        },
        "tree": "bd03127651335e3a51241f507f3bf194d8336485",
        "commit": "d06454c160218b4a782afad2429abda1add54df0",
        "message": "Allow user to specify git-dir on the command line.",
        "changes": [
            [23, 3, "git2json/__init__.py"]
        ]
        },
        // ... More commits
        ]


Usage Examples
==============

* [How Long Does It Take To Review an IPython Pull Request?](http://nbviewer.ipython.org/urls/raw.github.com/tarmstrong/code-analysis/master/IPythonReviewTime.ipynb) by Tavish Armstrong (git2json author)

If you are using ``git2json`` in interesting ways, please share and I will
add your notebooks/blog posts/code to this list.





History
-------

0.1.0 (2013-09-23)
++++++++++++++++++

* First release on PyPI.

0.1.1 (2013-09-25)
++++++++++++++++++

* Fixed broken PyPI package.

0.2.0 (2013-09-28)
++++++++++++++++++

* Parents now an array instead of a single value.

0.2.1 (2013-10-07)
++++++++++++++++++

* Re-implemented parser with regular expressions.
* Character encoding issues fixed.

0.2.2 (2013-11-09)
++++++++++++++++++

* Fix bug #7 (hidden filenames not parsed correctly): https://github.com/tarmstrong/git2json/issues/7

0.2.3 (2013-11-09)
++++++++++++++++++

* Python 3 compatibility
