README

==========
GitPython
==========

GitPython is a python library used to interact with Git repositories.

GitPython is a port of the grit library in Ruby created by 
Tom Preston-Werner and Chris Wanstrath.


REQUIREMENTS
============

* Git ( tested with 1.5.3.7 )
* Python Nose - used for running the tests
* Mock by Michael Foord used for tests. Requires 0.5

INSTALL
=======
If you have downloaded the source code:

	python setup.py install
	
or if you want to obtain a copy more easily: 

    easy_install gitpython
    
A distribution package can be obtained for manual installation at:

    http://pypi.python.org/pypi/GitPython

SOURCE
======

GitPython's git repo is available on Gitorious and GitHub, which can be browsed at:

http://gitorious.org/projects/git-python/
http://github.com/Byron/GitPython

and cloned using:

git clone git://gitorious.org/git-python/mainline.git git-python
git clone git://github.com/Byron/GitPython.git git-python


MAILING LIST
============
http://groups.google.com/group/git-python

ISSUE TRACKER
=============
http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones

LICENSE
=======

New BSD License.  See the LICENSE file.