GitPython is a python library used to interact with Git repositories.
Go to file
Sebastian Thiel ea43defd77
Run actions on main branch
2021-04-01 18:44:45 +08:00
.github/workflows Run actions on main branch 2021-04-01 18:44:45 +08:00
doc Fix changes.rst… 2021-03-14 00:06:51 +08:00
etc/sublime-text Fixed up coverage configuration 2015-01-06 18:49:44 +01:00
git Merge pull request #1198 from RyaxTech/replace-password-in-uri-by-stars 2021-03-19 19:09:44 +08:00
test Use copy and not inplace remove password + working case test 2021-03-16 10:16:34 +01:00
.appveyor.yml rebase on master 2021-02-26 15:01:49 +00:00
.codeclimate.yml Add Code Climate configuration 2017-03-03 19:56:00 +01:00
.coveragerc Fixed up coverage configuration 2015-01-06 18:49:44 +01:00
.deepsource.toml tools: update tool scripts after moving tests 2020-07-12 15:39:58 +02:00
.dockerignore Added a Dockerfile that creates a clean Ubuntu Xenial test environment 2019-05-05 13:22:53 +05:30
.gitattributes tools: update tool scripts after moving tests 2020-07-12 15:39:58 +02:00
.gitignore add newlines 2021-02-28 18:44:29 +00:00
.gitmodules As string is iterable, changed to isinstance check 2019-10-15 13:27:48 +02:00
.travis.yml rebase on master 2021-02-26 15:01:49 +00:00
AUTHORS add myself to authors 2020-08-31 19:19:17 +08:00
CHANGES Fix link to latest changelog 2016-05-24 20:02:02 +02:00 update contribution guidelines to be a little less concise and more polite 2020-09-03 10:21:40 +08:00
Dockerfile Fix spelling in Dockerfile description LABEL 2020-02-11 22:27:15 -06:00
LICENSE Lots of spring cleaning and added in Sphinx documentation. 2009-01-24 15:40:27 -05:00 update to exclude tests 2020-07-12 15:39:58 +02:00
Makefile Adjust signature key - please read if you verify installs/packages 2020-09-04 10:00:48 +08:00 drop py3.4 support 2021-02-28 17:52:45 +00:00
VERSION Combined commits to add types to and 2021-03-04 21:24:11 +00:00 Resolve test incompatibility with git v2.21.0 2019-05-05 16:19:32 -04:00 Adding command to to make sure submodules are recursively cloned as well 2019-10-21 13:10:28 +02:00
mypy.ini add newlines 2021-02-28 18:44:29 +00:00
release-verification-key.asc Adjust signature key - please read if you verify installs/packages 2020-09-04 10:00:48 +08:00
requirements.txt Combined commits to add types to and 2021-03-04 21:24:11 +00:00 add py.typed, mypy.ini and git/ 2021-02-28 18:04:24 +00:00
test-requirements.txt add types to git.__init__, compat, db, diff, exc, util 2021-03-16 22:08:20 +00:00
tox.ini Combined commits to add types to and 2021-03-04 21:24:11 +00:00

Gitoxide: A peek into the future…

I started working on GitPython in 2009, back in the days when Python was 'my thing' and I had great plans with it. Of course, back in the days, I didn't really know what I was doing and this shows in many places. Somewhat similar to Python this happens to be 'good enough', but at the same time is deeply flawed and broken beyond repair.

By now, GitPython is widely used and I am sure there is a good reason for that, it's something to be proud of and happy about. The community is maintaining the software and is keeping it relevant for which I am absolutely grateful. For the time to come I am happy to continue maintaining GitPython, remaining hopeful that one day it won't be needed anymore.

More than 15 years after my first meeting with 'git' I am still in excited about it, and am happy to finally have the tools and probably the skills to scratch that itch of mine: implement git in a way that makes tool creation a piece of cake for most.

If you like the idea and want to learn more, please head over to gitoxide, an implementation of 'git' in Rust.


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 the git executable to be installed on the system and available in your PATH for most operations. If it is not in your PATH, you can help GitPython find it by setting the GIT_PYTHON_GIT_EXECUTABLE=<path/to/git> environment variable.

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

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 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:

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

git clone
git submodule update --init --recursive


Leakage of System Resources

GitPython is not suited for long-running processes (like daemons) as it tends to leak system resources. It was written in a time where destructors (as implemented in the __del__ method) still ran deterministically.

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

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

Windows support

See Issue #525.


Important: Right after cloning this repository, please be sure to have executed the ./ script in the repository root. Otherwise you will encounter test failures.

On Windows, make sure you have git-daemon in your PATH. For MINGW-git, the git-daemon.exe exists in Git\mingw64\libexec\git-core\; CYGWIN has no daemon, but should get along fine with MINGW's.

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

pip install tox

Then run:


For more fine-grained control, you can use unittest.


Please have a look at the contributions file.


  • User Documentation
  • Questions and Answers
  • Please post on stackoverflow and use the gitpython 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

How to make a new release

  • Update/verify the version in the VERSION file
  • Update/verify that the doc/source/changes.rst changelog file was updated
  • Commit everything
  • Run git tag -s <version> to tag the version in Git
  • Run make release
  • Close the milestone mentioned in the changelog and create a new one. Do not reuse milestones by renaming them.
  • set the upcoming version in the VERSION file, usually be incrementing the patch level, and possibly by appending -dev. Probably you want to git push once more.

How to verify a release

Please only use releases from pypi as you can verify the respective source tarballs.

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

curl > gitpython.whl
curl >  gitpython-signature.asc
gpg --verify gitpython-signature.asc gitpython.whl

which outputs

gpg: Signature made Fr  4 Sep 10:04:50 2020 CST
gpg:                using RSA key 27C50E7F590947D7273A741E85194C08421980C9
gpg: Good signature from "Sebastian Thiel (YubiKey USB-C) <>" [ultimate]
gpg:                 aka "Sebastian Thiel (In Rust I trust) <>" [ultimate]

You can verify that the keyid indeed matches the release-signature key provided in this repository 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.asc
gpg --edit-key 4C08421980C9

> sign
> save

Projects using GitPython


New BSD License. See the LICENSE file.


Python package Documentation Status Packaging status

This project is in maintenance mode, which means that

  • …there will be no feature development, unless these are contributed
  • …there will be no bug fixes, unless they are relevant to the safety of users, or contributed
  • …issues will be responded to with waiting times of up to a month

The project is open to contributions of all kinds, as well as new maintainers.