If you like the idea and want to learn more, please head over to[gitoxide](https://github.com/Byron/gitoxide), an

implementation of 'git' in[Rust](https://www.rust-lang.org).

*(Please note that`gitoxide` is not currently available for use in Python, and that Rust is required)*

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

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.

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 settingthe`GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.

- Git (1.7.x or newer)

- Python >= 3.7

To obtain and install a copy[from PyPI](https://pypi.org/project/GitPython/), run:

pip install GitPython

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

pip install.

To clone the[the GitHub repository](https://github.com/gitpython-developers/GitPython) from source to work on the code, you can do it like so:

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

cd GitPython

./init-tests-after-clone.sh

If you are cloning[your own fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks), then replace the above`git clone` command with one that gives the URL of your fork. Or use this[`gh`](https://cli.github.com/) 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](https://docs.python.org/3/tutorial/venv.html).

Then make an[editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):

pip install -e".[test]"

If you want to do that*and* 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` to`pip install`. This can be done in any order, and in separate`pip install` commands or the same one, so long as`-e` appears before*each* 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

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

pip install -e".[test]"

Otherwise, you can run:

pip install -r test-requirements.txt

If you had installed with a command like`pip install -e .` instead, you can still run

the above command to add the testing dependencies.

To test, run:

pytest

To lint, and apply automatic code formatting, run:

To lint, and applysome linting fixes as well asautomatic 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 -p git

The same linting, and running tests on all the different supported Python versions, will be performed:

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 run[`tox`](https://tox.wiki/) (this skips any Python versions you don't have installed).

Specific tools:

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

- Configurations for`mypy`,`pytest`,`coverage.py`, and`black` are in`./pyproject.toml`.

- Configuration for`ruff` is in the`pyproject.toml` file.

-`pytest` (test runner)

-`coverage.py` (code coverage)

-`ruff` (linter and formatter)

-`mypy` (type checker)

Orchestration tools:

requires = tox>=4

env_list = py{37,38,39,310,311,312},lint,mypy, html

env_list = py{37,38,39,310,311,312}, mypy, html

description = Run unit tests