Repository files navigation

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 toPython 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 andprobably the skills to scratch that itch of mine: implementgit 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 togitoxide, animplementation of 'git' inRust.

(Please note thatgitoxide is not currently available for use in Python, and that Rust is required.)

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 often backed by calling thegitcommand-line program.

This project is inmaintenance 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.

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 itby setting theGIT_PYTHON_GIT_EXECUTABLE=<path/to/git> environment variable.

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

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

GitPython and its required package dependencies can be installed in any of the following ways, all of which should typically be done in avirtual environment.

To obtain and install a copyfrom PyPI, run:

pip install GitPython

(A distribution package can also be downloaded for manual installation atthe PyPI page.)

If you have downloaded the source code, run this from inside the unpackedGitPython directory:

pip install.

To clone thethe GitHub repository from source to work on the code, you can do it like so:

git clone https://github.com/gitpython-developers/GitPythoncd GitPython./init-tests-after-clone.sh

On Windows,./init-tests-after-clone.sh can be run in a Git Bash shell.

If you are cloningyour own fork, then replace the abovegit clone command with one that gives the URL of your fork. Or use thisgh command (assuming you havegh and your fork is calledGitPython):

gh repo clone GitPython

Having cloned the repo, create and activate yourvirtual environment.

Then make aneditable install:

pip install -e".[test]"

In the less common case that you do not want to install test dependencies,pip install -e . can be used instead.

In rare cases, you may want to work on GitPython and one or both of itsgitdb andsmmap dependencies at the same time, with changes in your local working copy of gitdb or smmap immediately reflected in the behavior of your local working copy of GitPython. This can be done by making editable installations of those dependencies in the same virtual environment where you install GitPython.

If you want to do thatand you want the versions in GitPython's git submodules to be used, then pass-e git/ext/gitdb and/or-e git/ext/gitdb/gitdb/ext/smmap topip install. This can be done in any order, and in separatepip install commands or the same one, so long as-e appears beforeeach path. For example, you can install GitPython, gitdb, and smmap editably in the currently active virtual environment this way:

pip install -e".[test]" -e git/ext/gitdb -e git/ext/gitdb/gitdb/ext/smmap

The submodules must have been cloned for that to work, but that will already be the case if you have run./init-tests-after-clone.sh. You can usepip list to check which packages are installed editably and which are installed normally.

To reiterate, this approach should only rarely be used. For most development it is preferable to allow the gitdb and smmap dependencices to be retrieved automatically from PyPI in their latest stable packaged versions.

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.

Ensure testing libraries are installed. This is taken care of already if you installed with:

pip install -e".[test]"

If you had installed with a command likepip install -e . instead, you can still runthe above command to add the testing dependencies.

To test, run:

pytest

To lint, and apply some linting fixes as well as automatic code formatting, run:

pre-commit run --all-files

This includes the linting and autoformatting done by Ruff, as well as some other checks.

To typecheck, run:

mypy

Style and formatting checks, and running tests on all the different supported Python versions, will be performed:

• Upon submitting a pull request.
• On each push,if you have a fork with GitHub Actions enabled.
• Locally, if you runtox (this skips any Python versions you don't have installed).

Specific tools are all configured in the./pyproject.toml file:

• pytest (test runner)
• coverage.py (code coverage)
• ruff (linter and formatter)
• mypy (type checker)

Orchestration tools:

• Configuration forpre-commit is in the./.pre-commit-config.yaml file.
• Configuration fortox is in./tox.ini.
• Configuration for GitHub Actions (CI) is in files inside./.github/workflows/.

Please have a look at thecontributions file.

• User Documentation
• Questions and Answers
• Please post on Stack Overflow 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

1. Update/verify theversion in theVERSION file.
2. Update/verify that thedoc/source/changes.rst changelog file was updated. It should include a link to the forthcoming release page:https://github.com/gitpython-developers/GitPython/releases/tag/<version>
3. Commit everything.
4. Rungit tag -s <version> to tag the version in Git.
5. Optionally create and activate avirtual environment. (Then the next step can installbuild andtwine.)
6. Runmake release.
7. Go toGitHub Releases and publish a new one with the recently pushed tag. Generate the changelog.

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

3-Clause BSD License, also known as the New BSD License. See theLICENSE file.

One file exclusively used for fuzz testing is subject toa separate license, detailed here.This file is not included in the wheel or sdist packages published by the maintainers of GitPython.