Overview / Install¶
GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing.
It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation.
The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming.
Installing GitPython is easily done using pip. Assuming it is installed, just run the following from the command-line:
# pip 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 pip and pypi can be found here:
Alternatively, you can install from the distribution using the setup.py script:
# python setup.py install
GitPython’s git repo is available on GitHub, which can be browsed at:
and cloned using:
$ git clone https://github.com/gitpython-developers/GitPython git-python
Initialize all submodules to obtain the required dependencies with:
$ cd git-python $ git submodule update --init --recursive
Finally verify the installation by running the nose powered unit tests:
The issue tracker is hosted by github:
GitPython is licensed under the New BSD License. See the LICENSE file for more information.