ModuleNotFoundError: No module named 'git' in Python

avatar

Borislav Hadzhiev

Mon Apr 18 20224 min read

ModuleNotFoundError: No module named 'git' in Python #

The Python "ModuleNotFoundError: No module named 'git'" occurs when we forget to install the GitPython module before importing it or install it in an incorrect environment. To solve the error, install the module by running the pip install GitPython command.

no module named git

Open your terminal in your project's root directory and install the GitPython module.

shell
# ๐Ÿ‘‡๏ธ in a virtual environment or using Python 2 pip install GitPython # ๐Ÿ‘‡๏ธ for python 3 (could also be pip3.10 depending on your version) pip3 install GitPython # ๐Ÿ‘‡๏ธ if you get permissions error sudo pip3 install GitPython # ๐Ÿ‘‡๏ธ if you don't have pip in your PATH environment variable python -m pip install GitPython # ๐Ÿ‘‡๏ธ for python 3 (could also be pip3.10 depending on your version) python3 -m pip install GitPython # ๐Ÿ‘‡๏ธ for Anaconda conda install -c conda-forge gitpython

After you install the GitPython package, try importing it like:

main.py
from git import Repo repo = Repo('/Users/example/Development/git-python') assert not repo.bare

The Python error "ModuleNotFoundError: No module named 'git'" occurs for multiple reasons:

  1. Not having the GitPython package installed by running pip install GitPython.
  2. Installing the package in a different Python version than the one you're using.
  3. Installing the package globally and not in your virtual environment.
  4. Your IDE running an incorrect version of Python.
  5. Naming your module git.py which would shadow the official module.
  6. Declaring a variable named git which would shadow the imported variable.

If the error persists, get your Python version and make sure you are installing the package using the correct Python version.

shell
python --version

get python version

For example, my Python version is 3.10.4, so I would install the GitPython package with pip3.10 install GitPython.

shell
pip3.10 install GitPython # ๐Ÿ‘‡๏ธ if you get permissions error use pip3 (NOT pip3.X) sudo pip3 install GitPython

Notice that the version number corresponds to the version of pip I'm using.

If the PATH for pip is not set up on your machine, replace pip with python3 -m pip:

shell
# ๐Ÿ‘‡๏ธ make sure to use your version of Python, e.g. 3.10 python3 -m pip install GitPython

If the "No module named 'git'" error persists, try restarting your IDE and development server / script.

You can check if you have the GitPython package installed by running the pip show GitPython command.

shell
# ๐Ÿ‘‡๏ธ check if you have GitPython installed pip3 show GitPython # ๐Ÿ‘‡๏ธ if you don't have pip setup in PATH python3 -m pip show GitPython

The pip show GitPython command will either state that the package is not installed or show a bunch of information about the package, including the location where the package is installed.

If the package is not installed, make sure your IDE is using the correct version of Python.

If you have multiple Python versions installed on your machine, you might have installed the GitPython package using the incorrect version or your IDE might be setup to use a different version.

For example, In VSCode, you can press CTRL + Shift + P or (โŒ˜ + Shift + P on Mac) to open the command palette.

Then type "Python select interpreter" in the field.

python select interpreter

Then select the correct python version from the drop down menu.

select correct python version

Your IDE should be using the same version of Python (including the virtual environment) that you are using to install packages from your terminal.

If you are using a virtual environment, make sure you are installing GitPython in your virtual environment and not globally.

You can try creating a virtual environment if you don't already have one.

shell
# ๐Ÿ‘‡๏ธ use correct version of Python when creating VENV python3 -m venv venv # ๐Ÿ‘‡๏ธ activate on Unix or MacOS source venv/bin/activate # ๐Ÿ‘‡๏ธ activate on Windows (cmd.exe) venv\Scripts\activate.bat # ๐Ÿ‘‡๏ธ activate on Windows (PowerShell) venv\Scripts\Activate.ps1 # ๐Ÿ‘‡๏ธ install GitPython in virtual environment pip install GitPython

Your virtual environment will use the version of Python that was used to create it.

If the error persists, make sure you haven't named a module in your project as git.py because that would shadow the original GitPython module.

You also shouldn't be declaring a variable named git as that would also shadow the original module.

If the error is not resolved, try to uninstall the GitPython package and then install it.

shell
# ๐Ÿ‘‡๏ธ check if you have GitPython installed pip3 show GitPython # ๐Ÿ‘‡๏ธ if you don't have pip setup in PATH python3 -m pip show GitPython # ๐Ÿ‘‡๏ธ uninstall GitPython pip3 uninstall GitPython # ๐Ÿ‘‡๏ธ if you don't have pip setup in PATH python3 -m pip uninstall GitPython # ๐Ÿ‘‡๏ธ install GitPython pip3 install GitPython # ๐Ÿ‘‡๏ธ if you don't have pip setup in PATH python3 -m pip install GitPython

Try restarting your IDE and development server / script.

You can also try to upgrade the version of the GitPython package.

shell
pip3 install GitPython --upgrade # ๐Ÿ‘‡๏ธ if you don't have pip setup in PATH python3 -m pip install GitPython --upgrade
If the error persists, I would suggest watching a quick video on how to use Virtual environments in Python.

This one is for using using virtual environments (VENV) on Windows:

This one is for using using virtual environments (VENV) on MacOS and Linux:

Use the search field on my Home Page to filter through my more than 1,000 articles.

Copyright ยฉ 2022 Borislav Hadzhiev