ModuleNotFoundError: No module named 'click' in Python

avatar

Borislav Hadzhiev

Last updated: Apr 20, 2022

banner

Photo from Unsplash

ModuleNotFoundError: No module named 'click' in Python #

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

no module named click

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

shell
# 👇️ in a virtual environment or using Python 2 pip install click # 👇️ for python 3 (could also be pip3.10 depending on your version) pip3 install click # 👇️ if you get permissions error sudo pip3 install click # 👇️ if you don't have pip in your PATH environment variable python -m pip install click # 👇️ for python 3 (could also be pip3.10 depending on your version) python3 -m pip install click # 👇️ for Anaconda conda install -c anaconda click

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

main.py
import click @click.command() @click.option("--count", default=1, help="Number of greetings.") @click.option("--name", prompt="Your name", help="The person to greet.") def hello(count, name): """Simple program that greets NAME for a total of COUNT times.""" for _ in range(count): click.echo(f"Hello, {name}!") if __name__ == '__main__': hello()

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

  1. Not having the click package installed by running pip install click.
  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 click.py which would shadow the official module.
  6. Declaring a variable named click 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 click package with pip3.10 install click.

shell
pip3.10 install click # 👇️ if you get permissions error use pip3 (NOT pip3.X) sudo pip3 install click

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 click

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

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

shell
# 👇️ check if you have click installed pip3 show click # 👇️ if you don't have pip set up in PATH python3 -m pip show click

The pip show click 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 click package using the incorrect version or your IDE might be set up 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 dropdown 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 click 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 click in virtual environment pip install click

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 click.py because that would shadow the original click module.

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

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

shell
# 👇️ check if you have click installed pip3 show click # 👇️ if you don't have pip set up in PATH python3 -m pip show click # 👇️ uninstall click pip3 uninstall click # 👇️ if you don't have pip set up in PATH python3 -m pip uninstall click # 👇️ install click pip3 install click # 👇️ if you don't have pip set up in PATH python3 -m pip install click

Try restarting your IDE and development server/script.

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

shell
pip3 install click --upgrade # 👇️ if you don't have pip set up in PATH python3 -m pip install click --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 virtual environments (VENV) on Windows:

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

Conclusion #

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

I wrote a book in which I share everything I know about how to become a better, more efficient programmer.
book cover
You can use the search field on my Home Page to filter through all of my articles.