ModuleNotFoundError: No module named 'xlsxwriter' in Python

avatar
Borislav Hadzhiev

Last updated: Apr 8, 2024
10 min

banner

# ModuleNotFoundError: No module named 'xlsxwriter' in Python

The Python "ModuleNotFoundError: No module named 'xlsxwriter'" occurs when we forget to install the xlsxwriter module before importing it or install it in an incorrect environment.

To solve the error, install the module by running the pip install xlsxwriter command.

no module named xlsxwriter

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

shell
# ๐Ÿ‘‡๏ธ In a virtual environment or using Python 2 pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 (could also be pip3.10 depending on your version) pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter pip install xlsxwriter --user # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 (could also be pip3.10 depending on your version) python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias (Windows) py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Anaconda conda install -c conda-forge xlsxwriter # ๐Ÿ‘‡๏ธ For Jupyter Notebook !pip install xlsxwriter

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

# Common reasons the error occurs

The Python error occurs for multiple reasons:

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

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

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 xlsxwriter

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 xlsxwriter package installed by running the pip show xlsxwriter command.

shell
# ๐Ÿ‘‡๏ธ Check if you have xlsxwriter installed pip show xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip set up in PATH python -m pip show xlsxwriter

The pip show xlsxwriter 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 xlsxwriter 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 xlsxwriter in your virtual environment and not globally.

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

shell
# ๐Ÿ‘‡๏ธ 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 xlsxwriter in your virtual environment pip install xlsxwriter

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

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

# Try reinstalling the package

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

shell
# ๐Ÿ‘‡๏ธ Check if you have xlsxwriter installed pip show xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip set up in PATH python -m pip show xlsxwriter # ๐Ÿ‘‡๏ธ Uninstall xlsxwriter pip uninstall xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip set up in PATH python -m pip uninstall xlsxwriter # ๐Ÿ‘‡๏ธ Install xlsxwriter pip install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip set up in PATH python -m pip install xlsxwriter

Try restarting your IDE and development server/script.

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

shell
pip install xlsxwriter --upgrade # ๐Ÿ‘‡๏ธ If you don't have pip set up in PATH python -m pip install xlsxwriter --upgrade
If the error persists, follow the operating system-specific instructions on how to install xlsxwriter.
  1. Install XlsxWriter on Windows
  2. Install XlsxWriter on macOS or Linux
  3. Install XlsxWriter in Visual Studio Code
  4. Install XlsxWriter in PyCharm
  5. Install XlsxWriter in Anaconda
  6. Install XlsxWriter in Jupyter Notebook

# Install XlsxWriter on Windows

To install the XlsxWriter module on Windows:

  1. Type CMD in the search bar and open the Command Prompt application.
  2. Type pip install xlsxwriter and press Enter.
cmd
pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error pip install xlsxwriter --user # ๐Ÿ‘‡๏ธ For Anaconda conda install -c conda-forge xlsxwriter

pip install xlsxwriter windows

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

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

shell
python -m pip install xlsxwriter python3 -m pip install xlsxwriter py -m pip install xlsxwriter

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

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

windows open powershell window here

  1. Click on "Open PowerShell window here".
  2. Run the following commands.
PowerShell
# ๐Ÿ‘‡๏ธ 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 xlsxwriter in your virtual environment pip install xlsxwriter

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
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
You can verify that the xlsxwriter module is installed by using the pip show xlsxwriter command.
PowerShell
pip show xlsxwriter pip3 show xlsxwriter python -m pip show xlsxwriter python3 -m pip show xlsxwriter

The pip show xlsxwriter 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 XlsxWriter on macOS or Linux

To install XlsxWriter on macOS or Linux:

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

search for terminal

terminal
pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Alternative if you get a permissions error pip install xlsxwriter --user # ๐Ÿ‘‡๏ธ For Anaconda conda install -c conda-forge xlsxwriter

macos linux install xlsxwriter

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

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

terminal
python -m pip install xlsxwriter python3 -m pip install xlsxwriter

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

terminal
sudo pip install xlsxwriter sudo pip3 install xlsxwriter

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

  1. Open your terminal in the root directory of your project.
  2. Run the following commands.
shell
# ๐Ÿ‘‡๏ธ Could also be "python -m venv venv" python3 -m venv venv # ๐Ÿ‘‡๏ธ Activate virtual env on macOS or Linux source venv/bin/activate # ๐Ÿ‘‡๏ธ Install xlsxwriter in your virtual environment pip install xlsxwriter

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 xlsxwriter has been installed successfully.

shell
pip show xlsxwriter pip3 show xlsxwriter python -m pip show xlsxwriter python3 -m pip show xlsxwriter

The pip show xlsxwriter command will either state that the package is not installed or show a bunch of information about the package.

# Install XlsxWriter in Visual Studio Code

To install XlsxWriter in Visual Studio Code:

  1. Press CTRL + ` (Backtick) on your keyboard to open the terminal.
  2. Run the pip install xlsxwriter command to install the xlsxwriter module.
terminal
pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Alternative if you get a permissions error pip install xlsxwriter --user

vscode pip install xlsxwriter

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 xlsxwriter package, try importing it as follows.

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

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
python --version python3 --version

get python version

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

terminal
# ๐Ÿ‘‡๏ธ 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 xlsxwriter in your virtual environment pip install xlsxwriter

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

# Install XlsxWriter in PyCharm

To install XlsxWriter in PyCharm:

  1. Press Alt+F12 on your keyboard to open the terminal.
  2. Run the pip install xlsxwriter command to install the xlsxwriter module.
terminal
pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Alternative if you get a permissions error pip install xlsxwriter --user

pycharm pip install xlsxwriter

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

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 XlsxWriter.
  3. Click on "Install Package".

pycharm interpreter install xlsxwriter

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
python --version python3 --version

get python version

# Install XlsxWriter in Anaconda

To install XlsxWriter in Anaconda:

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

anaconda navigator install package

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

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

shell
# ๐Ÿ‘‡๏ธ Using conda conda install -c conda-forge xlsxwriter # ๐Ÿ‘‡๏ธ Alternatively use `pip` pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Alternative if you get a permissions error pip install xlsxwriter --user

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

# Install XlsxWriter in Jupyter Notebook

To install XlsxWriter in Jupyter Notebook:

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

open jupyter notebook

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

jupyter notebook click new terminal

  1. Type pip install xlsxwriter and press Enter.
shell
# ๐Ÿ‘‡๏ธ Using pip pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you get a permissions error sudo pip3 install xlsxwriter # ๐Ÿ‘‡๏ธ If you don't have pip in your PATH environment variable python -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ For Python 3 python3 -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using py alias py -m pip install xlsxwriter # ๐Ÿ‘‡๏ธ Using conda conda install -c conda-forge xlsxwriter # ๐Ÿ‘‡๏ธ Alternative if you get a permissions error pip install xlsxwriter --user

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

main.py
import xlsxwriter workbook = xlsxwriter.Workbook('example.xlsx') worksheet = workbook.add_worksheet() worksheet.write('A1', 'First cell') workbook.close()

Alternatively, you can use the Python ipykernel.

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

open jupyter notebook

  1. Click on "New" and then click on "Python 3 (ipykernel)". jupyter notebook click new ipykernel

  2. Type !pip install xlsxwriter 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
!pip install xlsxwriter

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

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

shell
!pip install xlsxwriter --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.
book cover
You can use the search field on my Home Page to filter through all of my articles.

Copyright ยฉ 2024 Borislav Hadzhiev