GitPython

GixPython: Gitoxide for GitPython

GixPython provides the Python bindings for Gitoxide, an implementation of Git in Rust. GitPython's experimental Gix backend uses these bindings to execute supported operations through Gitoxide while exposing GitPython's high-level repository, commit, tree and index interfaces.

Supported object reads, tree traversal, reference/index queries and commit history can run without launching Git subprocesses. Each native operation opens a fresh Gix repository handle. The backend benchmarks measure results and CLI launch counts for both backends.

Activate the Gix backend

This backend is currently unreleased. From this source checkout, install the optional gix extra in a virtual environment:

python -m pip install ".[gix]"

The extra installs GixPython 0.3.0 from PyPI; its Python import name is gix. Set GIT_PYTHON_BACKEND=gix before importing GitPython, either in your environment or in Python:

import os

os.environ["GIT_PYTHON_BACKEND"] = "gix"
from git import Repo

with Repo(".") as repo:
    print(repo.head.commit.hexsha)

With GIT_PYTHON_BACKEND unset, GitPython automatically selects Gix when gix can be imported, otherwise CLI. Set it to cli to force Git subprocesses instead. Explicit gix selection fails if GixPython cannot be imported.

Prerequisites and coverage

• CPython 3.11 or newer for GixPython. GitPython itself still supports Python 3.8 or newer; on Python 3.8–3.10 the extra omits GixPython and uses CLI.
• Git 2.52 or newer, available in PATH or selected with GIT_PYTHON_GIT_EXECUTABLE, remains required for CLI fallbacks.
• GixPython 0.3.0 publishes macOS wheels. On Linux and Windows, installation builds its released source distribution and requires Rust 1.89 or newer and a system linker. Default hashing, compression and HTTPS dependencies use pure Rust and do not require a C/C++ compiler.

Unsupported operations and options retain the Git CLI path, including clone, fetch and push. Direct repo.git.<command>() calls also retain command-line behavior. Coverage and compatibility gaps are documented in the backend ledger and installation guide; the downstream audit starts with known API incompatibilities.

GitPython

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 the git command-line program.

DEVELOPMENT 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.

REQUIREMENTS

GitPython needs the git executable to be installed on the system and available in your PATH for repository 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 (2.52 or newer)
• Python >= 3.8

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

INSTALL

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

From PyPI

To obtain and install a copy from PyPI, run:

pip install GitPython

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

From downloaded source code

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

pip install .

By cloning the source code repository

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

git clone https://github.com/gitpython-developers/GitPython
cd GitPython

If you are cloning your own fork, then replace the above git clone command with one that gives the URL of your fork. Or use this gh command (assuming you have gh and your fork is called GitPython):

gh repo clone GitPython

Having cloned the repo, create and activate your virtual environment.

Then make an editable 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.

This is the beginning of the README. Read the rest at the original. Read the full README ↗