ModuleNotFoundError: No module named 'click' in Python

# 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

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

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

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

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

# 👇️ For Jupyter Notebook
!pip install click

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

main.py

Copied!
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()

# Common causes of the error

The error occurs for multiple reasons:

Not having the click package installed by running pip install click.
Installing the package in a different Python version than the one you're using.
Installing the package globally and not in your virtual environment.
Your IDE running an incorrect version of Python.
Naming your module click.py which would shadow the official module.
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

Copied!
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

Copied!
pip3.10 install click

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

Copied!
# 👇️ 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.

# Check if the package is installed

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

shell

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

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

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

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.

# Install the package in a Virtual Environment

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

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 click in your virtual environment
pip install click

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.

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.

# Try reinstalling the package

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

shell

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

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

# 👇️ Uninstall click
pip uninstall click

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

# 👇️ Install click
pip install click

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

Copied!
pip install click --upgrade

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

If the error persists, follow the operating system-specific instructions on how to install click.

# Table of Contents

# Install click on Windows

To install the click module on Windows:

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

cmd

Copied!
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

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

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

pip install click windows

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

main.py

Copied!
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()

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

Right-click on the search result, click on "Run as administrator" and run the pip install command.

run cmd as administrator

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

shell

Copied!
python -m pip install click

python3 -m pip install click

py -m pip install click

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

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

windows open powershell window here

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

PowerShell

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 click in your virtual environment
pip install click

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.

PowerShell

Copied!
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

You can verify that the click module is installed by using the pip show click command.

PowerShell

Copied!
pip show click
pip3 show click

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

# Install click on macOS or Linux

To install click on macOS or Linux:

Search for "terminal" and start the application.
Type pip install click and press Enter.

terminal

Copied!
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

macos linux install click

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

main.py

Copied!
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()

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

terminal

Copied!
python -m pip install click

python3 -m pip install click

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

terminal

Copied!
sudo pip install click

sudo pip3 install click

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

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

shell

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

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

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

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

If the python3 -m venv venv command doesn't work, use python -m venv venv instead.

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

shell

Copied!
pip show click
pip3 show click

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

# Install click in Visual Studio Code

To install click in Visual Studio Code:

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

terminal

Copied!
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

vscode pip install click

You can also open the terminal in Visual Studio Code by pressing CTRL+Shift+P and then type "View: Toggle Terminal".

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

main.py

Copied!
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()

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.

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.

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

terminal

Copied!
python --version
python3 --version

get python version

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

terminal

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 click in your virtual environment
pip install click

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

# Install click in PyCharm

To install click in PyCharm:

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

terminal

Copied!
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

pycharm pip install click

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

main.py

Copied!
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()

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

Click on "File" > "Settings" > "Project" > "Python Interpreter".
Click on the + icon and type click.
Click on "Install Package".

pycharm interpreter install click

When installing Python modules in PyCharm, make sure that your IDE is configured to use the correct version of Python.

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

pycharm select correct interpreter

Then Select the correct Python version from the dropdown menu.

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

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

terminal

Copied!
python --version
python3 --version

get python version

# Install click in Anaconda

To install click in Anaconda:

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

anaconda navigator install package

Alternatively, you can install the click 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 click package.

shell

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

# 👇️ Alternatively use `pip`
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

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

main.py

Copied!
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()

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

# Install click in Jupyter Notebook

To install click in Jupyter Notebook:

Open your terminal and type "jupyter notebook".

open jupyter notebook

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

jupyter notebook click new terminal

Type pip install click and press Enter.

shell

Copied!
# 👇️ Using pip
pip install click

# 👇️ For Python 3
pip3 install click

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

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

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

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

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

main.py

Copied!
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()

Alternatively, you can use the Python ipykernel.

Open your terminal and type "jupyter notebook".

open jupyter notebook

Click on "New" and then click on "Python 3 (ipykernel)".
Type !pip install click and click on "Run".

jupyter notebook install module

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

shell

Copied!
!pip install click

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

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

shell

Copied!
!pip install click --user

jupyter notebook install with user option

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

I wrote a book in which I share everything I know about how to become a better, more efficient programmer.

You can use the search field on my Home Page to filter through all of my articles.

ModuleNotFoundError: No module named 'click' in Python