### Navigation

- index
- modules |
- next |
- previous |
- GitPython v0.2.0 Beta documentation »

# Overview / Install

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

GitPython was a port of the grit library in Ruby created by Tom Preston-Werner and Chris Wanstrath, but grew beyond its heritage through its improved design and performance.

## Requirements

- Git tested with 1.5.3.7
- Requires Git 1.6.5.4 or newer if index.add function is to be used
- Python Nose - used for running the tests
- Mock by Michael Foord used for tests. Requires 0.5

## Installing GitPython

Installing GitPython is easily done using setuptools. Assuming it is installed, just run the following from the command-line:

    # easy_install GitPython

This command will download the latest version of GitPython from the Python Package Index and install it to your system. More information about `easy_install` and pypi can be found here:

- setuptools
- install setuptools
- pypi

Alternatively, you can install from the distribution using the `setup.py` script:

    # python setup.py install

## Getting Started

- GitPython Tutorial - This tutorial provides a walk-through of some of the basic functionality and concepts used in GitPython. It, however, is not exhaustive so you are encouraged to spend some time in the API Reference.

## API Reference

An organized section of the GitPthon API is at API Reference.

## Source Code

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 Information

GitPython is licensed under the New BSD License. See the LICENSE file for more information.

### Navigation

- index
- modules |
- next |
- previous |
- GitPython v0.2.0 Beta documentation »