ModuleNotFoundError: No module named 'rest_framework'

avatar
Borislav Hadzhiev

Last updated: Apr 10, 2024
14 min

banner

# ModuleNotFoundError: No module named 'rest_framework'

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

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

modulenotfounderror no module named rest framework

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

shell
# 👇️ In a virtual environment or using Python 2
pip install djangorestframework

# 👇️ For Python 3 (could also be pip3.10 depending on your version)
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework
pip install djangorestframework --user

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

# 👇️ For Python 3 (could also be pip3.10 depending on your version)
python3 -m pip install djangorestframework

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

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

# 👇️ For Jupyter Notebook
!pip install djangorestframework

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore, not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

If you get the error ModuleNotFoundError: No module named 'django', click on the link and follow the instructions.

# Common causes of the error

The error occurs for multiple reasons:

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

shell
pip3.10 install djangorestframework

# 👇️ If you get a permissions error use pip3 (NOT pip3.X)
sudo pip3 install djangorestframework

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 djangorestframework

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

shell
# 👇️ Check if you have djangorestframework installed
pip show djangorestframework

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

The pip show djangorestframework 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 djangorestframework 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 get the error ModuleNotFoundError: No module named 'django', click on the link and follow the instructions.

# Install the package in a Virtual Environment

If you are using a virtual environment, make sure you are installing djangorestframework 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 `djangorestframework` in your virtual environment
pip install djangorestframework

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

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

# Try reinstalling the package

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

shell
# 👇️ Check if you have djangorestframework installed
pip show djangorestframework

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

# 👇️ Uninstall djangorestframework
pip uninstall djangorestframework

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

# 👇️ Install djangorestframework
pip install djangorestframework

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

Try restarting your IDE and development server/script.

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

shell
pip install djangorestframework --upgrade

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

# Import "rest_framework" could not be resolved from source

The error "Import "rest_framework" could not be resolved from source Pylance" occurs when the djangorestframework module is not installed or you have selected the incorrect Python interpreter in your IDE (e.g. Visual Studio Code).

To solve the error, install djangorestframework and select the correct Python interpreter in your IDE.

import rest-framework could not be resolved from source

# Make sure the correct Python interpreter is selected in your IDE

If you have multiple Python versions installed on your machine, you might have installed the djangorestframework package using the incorrect version or your IDE might be set up to use a different version.

For example, In Visual Studio Code you can:

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

Then type "Python select interpreter" in the search field.

python select interpreter

  1. 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 the error persists, try restarting your IDE and development server/script. VSCode often glitches and a reboot resolves the issue.

If the error is not resolved, try to use the Visual Studio Code terminal to install the djangorestframework module.

You can press CTRL + ` (Backtick) on your keyboard to open the Visual Studio code terminal.

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

open vscode terminal

Once you open the terminal, Visual Studio Code will automatically activate your virtual environment (if you have one).

Run the pip install djangorestframework command.

shell
pip install djangorestframework

If the error persists, try to select the Python interpreter by specifying the path:

  1. Press CTRL + Shift + P or (⌘ + Shift + P on Mac) to open the command palette.
  2. Type "Python select interpreter" in the field.

python select interpreter

  1. Select "Enter interpreter path...".

select enter interpreter path

  1. Click on "Find".

click find

  1. In the window that opens, navigate to your Python executable:
  • If you have a virtual environment on Windows, click on your venv folder, then double-click on the Scripts folder, select the python.exe file and then Select interpreter.

windows specify path to interpreter

  • If you have a virtual environment on macOS or Linux, click on your venv folder, then double-click on the bin folder, select the python file and then Select interpreter.

macos linux specify path to interpreter

  • If you don't have a virtual environment, use one of the following commands to get your path to your python.exe or python executable, specify the path to the file and select the executable.
cmd
where python

python -c "import sys; print(sys.executable)"

find python path

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

# Alternatively, use a comment to disable the warning

If none of the suggestions helped, you can use a comment to disable the Pylance warning in your IDE.

main.py
import rest_framework  # type: ignore

print(rest_framework)

You simply have to add the # type: ignore command on the same line as the import statement to disable the check for the specific import.

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

# Table of Contents

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

# Install Django REST framework on Windows

To install the djangorestframework module on Windows:

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

# 👇️ For Python 3
pip3 install djangorestframework

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

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

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

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

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

pip install django-rest-framework windows

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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

shell
python -m pip install djangorestframework

python3 -m pip install djangorestframework

py -m pip install djangorestframework

Alternatively, you can install the djangorestframework 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 djangorestframework in your virtual environment
pip install djangorestframework

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 djangorestframework module is installed by using the pip show djangorestframework command.
PowerShell
pip show djangorestframework
pip3 show djangorestframework

python -m pip show djangorestframework
python3 -m pip show djangorestframework

The pip show djangorestframework 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 Django REST framework on macOS or Linux

To install djangorestframework on macOS or Linux:

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

search for terminal

terminal
pip install djangorestframework

# 👇️ For Python 3
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework

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

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

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

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

macos linux install django-rest-framework

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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

terminal
python -m pip install djangorestframework

python3 -m pip install djangorestframework

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

terminal
sudo pip install djangorestframework

sudo pip3 install djangorestframework

Alternatively, you can install the djangorestframework 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 djangorestframework in your virtual environment
pip install djangorestframework

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

shell
pip show djangorestframework
pip3 show djangorestframework

python -m pip show djangorestframework
python3 -m pip show djangorestframework

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

# Install Django REST framework in Visual Studio Code

To install djangorestframework in Visual Studio Code:

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

# 👇️ For Python 3
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework

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

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

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

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

vscode pip install django-rest-framework

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 djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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

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

# Install Django REST framework in PyCharm

To install djangorestframework in PyCharm:

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

# 👇️ For Python 3
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework

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

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

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

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

pycharm pip install django-rest-framework

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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

pycharm interpreter install django-rest-framework

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 Django REST framework in Anaconda

You can install the djangorestframework 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 djangorestframework package.

shell
# 👇️ Using conda
conda install -c conda-forge djangorestframework

# 👇️ Alternatively use `pip`
pip install djangorestframework

# 👇️ For Python 3
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework

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

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

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

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

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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

# Install Django REST framework in Jupyter Notebook

To install djangorestframework 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 djangorestframework and press Enter.
shell
# 👇️ Using pip
pip install djangorestframework

# 👇️ For Python 3
pip3 install djangorestframework

# 👇️ If you get a permissions error
sudo pip3 install djangorestframework

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

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

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

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

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

After you install the djangorestframework package, add rest_framework to your INSTALLED_APPS.

settings.py
INSTALLED_APPS = [
    # ...
    'rest_framework',
]
Make sure to add the trailing comma after the entry because if you don't, a ModuleNotFoundError occurs.

Make sure you haven't mistyped rest_framework in your import statements (it's an underscore not a hyphen).

main.py
from rest_framework import routers, serializers, viewsets

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 djangorestframework 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 djangorestframework

Once you type the command, click "Run" to install the djangorestframework 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 djangorestframework --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.
About
Contacts
Policy
Terms & Conditions
TwitterGitHubLinkedin

Copyright © 2024 Borislav Hadzhiev

0
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........
.........