ModuleNotFoundError: No module named 'git' in Python

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

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

Copied!
# 👇️ 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 a permissions error
sudo pip3 install GitPython
pip install GitPython --user

# 👇️ 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

# 👇️ Using py alias (Windows)
py -m pip install GitPython

# 👇️ For Anaconda
conda install -c conda-forge gitpython

# 👇️ For Jupyter Notebook
!pip install GitPython

After you install the GitPython package, try importing it as follows.

Copied!
from git import Repo

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

# Common causes of the error

The error 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.

Copied!
python --version

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

Copied!
pip3.10 install GitPython

# 👇️ If you get a 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:

Copied!
# 👇️ Make sure to use your version of Python, e.g. 3.10
python3 -m pip install GitPython

If the error persists, try restarting your IDE and development server/script.

# Check if the package is installed

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

Copied!
# 👇️ Check if you have GitPython installed
pip show GitPython

# 👇️ If you don't have pip set up in PATH
python -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.

# Make sure your IDE is using the correct Python version

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

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.

Then Select the correct Python version from the dropdown menu.

# Install the package in a Virtual Environment

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.

Copied!
# 👇️ Use the 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 the virtual environment
pip install GitPython

If the python3 -m venv venv command doesn't work, try the following 2 commands:

• python -m venv venv
• py -m venv venv

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

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

# Try reinstalling the package

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

Copied!
# 👇️ Check if you have GitPython installed
pip show GitPython

# 👇️ If you don't have pip set up in PATH
python -m pip show GitPython

# 👇️ Uninstall GitPython
pip uninstall GitPython

# 👇️ If you don't have pip set up in PATH
python -m pip uninstall GitPython

# 👇️ Install GitPython
pip install GitPython

# 👇️ If you don't have pip set up in PATH
python -m pip install GitPython

Try restarting your IDE and development server/script.

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

Copied!
pip install GitPython --upgrade

# 👇️ If you don't have pip set up in PATH
python -m pip install GitPython --upgrade

# Table of Contents

1. Install GitPython on Windows
2. Install GitPython on macOS or Linux
3. Install GitPython in Visual Studio Code
4. Install GitPython in PyCharm
5. Install GitPython in Anaconda
6. Install GitPython in Jupyter Notebook

# Install GitPython on Windows

To install the GitPython module on Windows:

1. Type CMD in the search bar and open the Command Prompt application.
2. Type pip install gitpython and press Enter.

Copied!
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you don't have pip in your PATH environment variable
python -m pip install gitpython

# 👇️ For Python 3
python3 -m pip install gitpython

# 👇️ Using py alias
py -m pip install gitpython

# 👇️ If you get a permissions error
pip install gitpython --user

# 👇️ For Anaconda
conda install -c conda-forge gitpython

If the command doesn't succeed, try running CMD as an administrator.

If you get the error 'pip' is not recognized as an internal or external command, use the python -m command when installing GitPython.

Copied!
python -m pip install gitpython

python3 -m pip install gitpython

py -m pip install gitpython

Alternatively, you can install the GitPython module in a virtual environment:

1. Open the root directory of your project.
2. Press Shift and right-click in Explorer.

3. Click on "Open PowerShell window here".
4. Run the following commands.

Copied!
# 👇️ Might also be: "python3 -m venv venv"
python -m venv venv

# 👇️ Activate on Windows (PowerShell)
venv\Scripts\Activate.ps1

# 👇️ Activate on Windows (cmd.exe)
venv\Scripts\activate.bat

# 👇️ Install gitpython in your virtual environment
pip install gitpython

If the python -m venv venv command doesn't work, try the following 2 commands:

• python3 -m venv venv
• py -m venv venv.

If you see an error message that ps1 cannot be loaded because running scripts is disabled on this system, run the following command, type "yes" when prompted and rerun the activation command.

Copied!
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Copied!
pip show gitpython
pip3 show gitpython

python -m pip show gitpython
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.

# Install GitPython on macOS or Linux

To install GitPython on macOS or Linux:

1. Search for "terminal" and start the application.
2. Type pip install gitpython and press Enter.

Copied!
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you get a 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
python3 -m pip install gitpython

# 👇️ Alternative if you get a permissions error
pip install gitpython --user

# 👇️ For Anaconda
conda install -c conda-forge gitpython

If you get an error that pip isn't found, use the python -m command.

Copied!
python -m pip install gitpython

python3 -m pip install gitpython

If you get a permissions error, prefix the command with sudo.

Copied!
sudo pip install gitpython

sudo pip3 install gitpython

Alternatively, you can install the GitPython package in a virtual environment:

1. Open your terminal in the root directory of your project.
2. Run the following commands.

Copied!
# 👇️ Could also be "python -m venv venv"
python3 -m venv venv

# 👇️ Activate virtual env on macOS or Linux
source venv/bin/activate

# 👇️ Install gitpython in your virtual environment
pip install gitpython

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

You can use the pip show command to verify gitpython has been installed successfully.

Copied!
pip show gitpython
pip3 show gitpython

python -m pip show gitpython
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.

# Install GitPython in Visual Studio Code

To install GitPython in Visual Studio Code:

1. Press CTRL + ` (Backtick) on your keyboard to open the terminal.
2. Run the pip install gitpython command to install the gitpython module.

Copied!
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you get a 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
python3 -m pip install gitpython

# 👇️ Using py alias
py -m pip install gitpython

# 👇️ Alternative if you get a permissions error
pip install gitpython --user

When installing Python modules in Visual Studio code, make sure that your IDE is configured to use the correct Python version.

Press CTRL+Shift+P or (⌘ + Shift + P on Mac) to open the command palette.

Then type "Python select interpreter" in the field.

Then Select the correct Python version from the dropdown menu.

You can use the python --version command if you need to get your version of Python.

Copied!
python --version
python3 --version

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

Copied!
# 👇️ Could also be "python -m venv venv" or "py -m venv 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 the virtual environment
pip install gitpython

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

# Install GitPython in PyCharm

To install GitPython in PyCharm:

1. Press Alt+F12 on your keyboard to open the terminal.
2. Run the pip install gitpython command to install the gitpython module.

Copied!
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you get a 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
python3 -m pip install gitpython

# 👇️ Using py alias
py -m pip install gitpython

# 👇️ Alternative if you get a permissions error
pip install gitpython --user

Alternatively, you can use the IDE itself to install the module.

1. Click on "File" > "Settings" > "Project" > "Python Interpreter".
2. Click on the + icon and type GitPython.
3. Click on "Install Package".

Click on "File" > "Settings" > "Project" > "Python Interpreter".

Then Select the correct Python version from the dropdown menu.

You can use the python --version command if you need to get your version of Python.

Copied!
python --version
python3 --version

# Install GitPython in Anaconda

To install GitPython in Anaconda:

1. Open your Anaconda Navigator.
2. Click on "Environments" and select your project.
3. Type gitpython in the search bar to the right.
4. Tick the gitpython package and click on "Apply".

Alternatively, you can install the gitpython package with a command.

If you are on Windows, search for "Anaconda Prompt" and open the application.

If you are on macOS or Linux, open your terminal.

Run the following command to install the gitpython package.

Copied!
# 👇️ Using conda
conda install -c conda-forge gitpython

# 👇️ Alternatively use `pip`
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you get a 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
python3 -m pip install gitpython

# 👇️ Using py alias
py -m pip install gitpython

# 👇️ Alternative if you get a permissions error
pip install gitpython --user

Click on the following article if you need to install a specific version of the package using Anaconda.

# Install GitPython in Jupyter Notebook

To install GitPython in Jupyter Notebook:

1. Open your terminal and type "jupyter notebook".

2. Click on "New" and then "Terminal" in the browser tab.

3. Type pip install gitpython and press Enter.

Copied!
# 👇️ Using pip
pip install gitpython

# 👇️ For Python 3
pip3 install gitpython

# 👇️ If you get a 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
python3 -m pip install gitpython

# 👇️ Using py alias
py -m pip install gitpython

# 👇️ Using conda
conda install -c conda-forge gitpython

# 👇️ Alternative if you get a permissions error
pip install gitpython --user

Alternatively, you can use the Python ipykernel.

1. Open your terminal and type "jupyter notebook".

2. Click on "New" and then click on "Python 3 (ipykernel)".

3. Type !pip install gitpython and click on "Run".

Note that the pip install command must be prefixed with an exclamation mark if you use this approach.

Copied!
!pip install gitpython

Once you type the command, click "Run" to install the gitpython module.

If you get a permissions error, e.g. "[WinError: 5] Access is denied", add the --user option to the installation command.

Copied!
!pip install gitpython --user

If the error persists, try to restart the Jupyter Kernel and rerun the command.