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 additionallyallows you to access the git repository more directly using either a pure python implementation,or the faster, but more resource intensivegit 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 availablein yourPATH for most operations.If it is not in yourPATH, you can help GitPython find it by settingtheGIT_PYTHON_GIT_EXECUTABLE=<path/to/git> environment variable.

• Git (1.7.x or newer)
• Python >= 3.4

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

If you like to clone from source, you can do it like so:

git clone https://github.com/gitpython-developers/GitPythongit submodule update --init --recursive./init-tests-after-clone.sh

GitPython is not suited for long-running processes (like daemons) as it tends toleak system resources. It was written in a time where destructors (as implementedin the__del__ method) still ran deterministically.

In case you still want to use it in such a context, you will want to search thecodebase for__del__ implementations and call these yourself when you see fit.

Another way assure proper cleanup of resources is to factor out GitPython into aseparate process which can be dropped periodically.

SeeIssue #525.

Important: Right after cloning this repository, please be sure to have executedthe./init-tests-after-clone.sh script in the repository root. Otherwiseyou will encounter test failures.

OnWindows, make sure you havegit-daemon in your PATH. For MINGW-git, thegit-daemon.exeexists inGit\mingw64\libexec\git-core\; CYGWIN has no daemon, but should get along finewith MINGW's.

The easiest way to run tests is by usingtoxa wrapper around virtualenv. It will take care of setting up environments with the properdependencies installed and execute test commands. To install it simply:

pip install tox

Then run:

tox

For more fine-grained control, you can useunittest.

Please have a look at thecontributions file.

• 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 theversion in theVERSION file
• Update/verify that thedoc/source/changes.rst changelog file was updated
• Commit everything
• Rungit tag -s <version> to tag the version in Git
• Runmake release
• Close the milestone mentioned in thechangelog and create a new one.Do not reuse milestones by renaming them.
• set the upcoming version in theVERSION file, usually beincrementing the patch level, and possibly by appending-dev. Probably youwant togit push once more.

Please only use releases frompypi as you can verify the respective sourcetarballs.

This script shows how to verify the tarball was indeed created by the authors ofthis project:

curl https://pypi.python.org/packages/5b/38/0433c06feebbfbb51d644129dbe334031c33d55af0524326266f847ae907/GitPython-2.1.8-py2.py3-none-any.whl#md5=6b73ae86ee2dbab6da8652b2d875013a  > gitpython.whlcurl https://pypi.python.org/packages/5b/38/0433c06feebbfbb51d644129dbe334031c33d55af0524326266f847ae907/GitPython-2.1.8-py2.py3-none-any.whl.asc > gitpython-signature.ascgpg --verify gitpython-signature.asc gitpython.whl

which outputs

gpg: Signature made Mon Dec 11 17:34:17 2017 CETgpg:                using RSA key C3BC52BD76E2C23BAC6EC06A665F99FA9D99966Cgpg:                issuer "byronimo@gmail.com"gpg: Good signature from "Sebastian Thiel (I do trust in Rust!) <byronimo@gmail.com>" [ultimate]

You can verify that the keyid indeed matches the release-signature key provided in thisrepository by looking at the keys details:

gpg --list-packets ./release-verification-key.asc

You can verify that the commit adding it was also signed by it using:

git show --show-signature  ./release-verification-key.asc

If you would like to trust it permanently, you can import and sign it:

gpg --import ./release-verification-key.ascgpg --edit-key 88710E60> sign> save

• PyDriller
• Kivy Designer
• Prowl
• Python Taint
• Buster
• git-ftp
• Git-Pandas
• PyGitUp
• PyJFuzz
• Loki
• Omniwallet
• GitViper
• Git Gud

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-pythonreturn to a proper state, which means

• no open pull requests
• no open issues describing bugs