In Python, ModuleNotFoundError: No module named ‘git’ error if we try to import the occurs ‘GitPython‘ module without installing the package or if you have not installed it in the correct environment.
In this tutorial, let’s look at installing the
GitPython module correctly in different operating systems and solve ModuleNotFoundError: No module named ‘git’ error.
What is ModuleNotFoundError: No module named ‘git’?
There are various reasons why we get the ModuleNotFoundError: No module named ‘git’ error
- Trying to use the module- without installing the GitPython package.
- If the IDE is set to the incorrect version of the Python/Python interpreter.
- You are using the virtual environment and the GitPython module is not installed inside a virtual environment
- Installing the GitPython package in a different version of Python than the one which is currently used.
- Declaring a variable name as the module name(GitPython)
If you are getting an error installing pip, checkout pip: command not found to resolve the issue.
How to fix ModuleNotFoundError: No module named ‘git’?
GitPython is not a built-in module (it doesn’t come with the default python installation) in Python; you need to install it explicitly using the pip installer and then use it.
GitPython is a python library used to interact with Git repositories.GitPython provides object model access to your git repository.
We can fix the error by installing the ‘GitPython’‘ module by running the
pip install GitPython command in your terminal/shell.
We can verify if the package is installed correctly by running the following command in the terminal/shell.
This will provide the details of the package installed, including the version number, license, and the path it is installed. If the module is not installed, you will get a warning message in the terminal stating WARNING: Package(s) not found: GitPython.
pip show GitPython
Name: GitPython Version: 3.1.27 Summary: GitPython is a python library used to interact with Git repositories Home-page: https://github.com/gitpython-developers/GitPython Author: Sebastian Thiel, Michael Trier Author-email: email@example.com, firstname.lastname@example.org License: BSD Location: c:personalijspython_samplesvenvlibsite-packages Requires: gitdb
Solution 1 – Installing and using the GitPython module in a proper way
Based on the Python version and the operating system you are running, run the relevant command to install the GitPython module.
# If you are using Python 2 (Windows) pip install GitPython # if you are using Python 3 (Windows) pip3 install GitPython # If the pip is not set as environment varibale PATH python -m pip install GitPython # If you are using Python 2 (Linux) sudo pip install GitPython # if you are using Python 3 (Linux) sudo pip3 install GitPython # In case if you have to easy_install sudo easy_install -U GitPython # On Centos yum install GitPython # On Ubuntu sudo apt-get install GitPython # If you are installing it in Anaconda conda install -c conda-forge gitpython
Once you have installed the GitPython module, we can now import it inside our code and use it as shown below.
from git import Repo # rorepo is a Repo instance pointing to the git-python repository. # For all you know, the first argument to Repo is a path to the repository # you want to work with repo = Repo(self.rorepo.working_tree_dir) assert not repo.bare
Solution 2 – Verify if the IDE is set to use the correct Python version
If you are still getting the same error even after installing the package, you can verify if the IDE you are using is configured with the correct version of the Python interpreter.
For Eg:- In the case of Visual Studio Code, we can set the Python version by pressing
CTRL + Shift + Por (
P on Mac) to open the command palette.
Once the command palette opens, select the Python interpreter and select the correct version of Python and also the virtual environment(if configured) as shown below.
Solution 3 – Installing GitPython inside the virtual environment
Many different IDEs like Jupyter Notebook, Spyder, Anaconda, or PyCharm often install their own virtual environment of Python to keep things clean and separated from your global Python.
If you are using VS Code, then you can also create a virtual environment, as shown below.
In the case of virtual environments, you need to ensure that the GitPython module needs to be installed inside the virtual environment and not globally.
Step 1: Create a Virtual Environment. If you have already created a virtual environment, then proceed to step 2.
Step 2: Activate the Virtual Environment
Step 3: Install the required module using the
pip install command
# Create a virtual Environment py -3 -m venv venv # Activate the virtual environment (windows command) venvScriptsactivate.bat # Activate the virtual environment (windows powershell) venvScriptsActivate.ps1 # Activate the virtual environment (Linux) source venv/bin/activate # Install GitPython inside the virtual environment pip install GitPython
Solution 4 – Ensure that a module name is not declared name a variable name.
Last but not least, you may need to cross-check and ensure that you haven’t declared a variable with the same name as the module name.
You should check if you haven’t named any files as
git.py as it may shadow the original GitPython module.
If the issue is still not solved, you can try removing the package and installing it once again, restart the IDE, and check the paths to ensure that packages are installed in the correct environment path and Python version.
The ModuleNotFoundError: No module named ‘git’ error when we try to import the occurs ‘GitPython‘ module without installing the package or if you have not installed it in the correct environment.
We can resolve the issue by installing the GitPython module by running the
pip install GitPython command. Also, ensure that the module is installed in the proper environment in case you use any virtual environments, and the Python version is appropriately set in the IDE that you are running the code.