Repository files navigation

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.

GitPython needs thegit executable to be installed on the system and available in yourPATH for most operations. If it is not in yourPATH, you can help GitPython find it by setting theGIT_PYTHON_GIT_EXECUTABLE=<path/to/git> environment variable.

• Git (1.7.x or newer)
• Python 2.7 to 3.5, while python 2.6 is supported on abest-effort basis.

The list of dependencies are listed in./requirements.txt and./test-requirements.txt. The installer takes care of installing them for you.

If you have downloaded the source code:

python setup.py install

or if you want to obtain a copy from the Pypi repository:

pip install gitpython

Both commands will install the required package dependencies.

A distribution package can be obtained for manual installation at:

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

The easiest way to run test is by usingtox a wrapper around virtualenv. It will take care of setting up environnements with the proper dependencies installed and execute test commands. To install it simply:

pip install tox

Then run:

tox

Please have a look at thecontributions file.

You can watch me fix issues or implement new featureslive on Twitch, or have a look atpast recordings on youtube

• Live on Twitch (just follow the channel to be notified when a session starts)
• Archive on Youtube

• User Documentation
• Questions and Answers
• Please post on stackoverflow and use thegitpython tag
• Issue Tracker
  • Post reproducible bugs and feature requests as a new issue. Please be sure to provide the following information if posting bugs:
    • GitPython version (e.g.import git; git.__version__)
    • Python version (e.g.python --version)
    • The encountered stack-trace, if applicable
    • Enough information to allow reproducing the issue

• Update/verify the version in theVERSION file
• Update/verify that the changelog has been updated
• Commit everything
• Rungit tag <version> to tag the version in Git
• Runmake release
• Finally, set the upcoming version in theVERSION file, usually beincrementing the patch level, and possibly by appending-dev. Probably youwant togit push once more.

New BSD License. See the LICENSE file.

Now that there seems to be a massive user base, this should be motivation enough to let git-python return to a proper state, which means

• no open pull requests
• no open issues describing bugs