Solve - No module named 'flask_restful' in Python

Solve - No module named 'flask_restful' in Python #

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

Open your terminal in your project's root directory and install the Flask-RESTful module.

Copied!
# 👇️ in a virtual environment or using Python 2
pip install Flask-RESTful

# 👇️ for python 3 (could also be pip3.10 depending on your version)
pip3 install Flask-RESTful

# 👇️ if you get permissions error
sudo pip3 install Flask-RESTful

# 👇️ if you don't have pip in your PATH environment variable
python -m pip install Flask-RESTful

# 👇️ for python 3 (could also be pip3.10 depending on your version)
python3 -m pip install Flask-RESTful

# 👇️ for Anaconda
conda install -c conda-forge flask-restful

After you install the Flask-RESTful package, try importing it like:

Copied!
from flask_restful import Resource, Api
from flask import Flask

app = Flask(__name__)
api = Api(app)


class HelloWorld(Resource):
    def get(self):
        return {'hello': 'world'}


api.add_resource(HelloWorld, '/')

if __name__ == '__main__':
    app.run(debug=True)

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

1. Not having the Flask-RESTful package installed by running pip install Flask-RESTful.
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.

If the error persists, get your Python version and make sure you are installing the package using the correct Python version.

Copied!
python --version

For example, my Python version is 3.10.4, so I would install the Flask-RESTful package with pip3.10 install Flask-RESTful.

Copied!
pip3.10 install Flask-RESTful

# 👇️ if you get permissions error use pip3 (NOT pip3.X)
sudo pip3 install Flask-RESTful

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:

Copied!
# 👇️ make sure to use your version of Python, e.g. 3.10
python3 -m pip install Flask-RESTful

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

You can check if you have the Flask-RESTful package installed by running the pip show Flask-RESTful command.

Copied!
# 👇️ check if you have Flask-RESTful installed
pip3 show Flask-RESTful

# 👇️ if you don't have pip setup in PATH
python3 -m pip show Flask-RESTful

The pip show Flask-RESTful 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.

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.

Then select the correct python version from the drop down menu.

If you are using a virtual environment, make sure you are installing Flask-RESTful in your virtual environment and not globally.

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

Copied!
# 👇️ 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 Flask-RESTful in virtual environment
pip install Flask-RESTful

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

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

Copied!
# 👇️ check if you have Flask-RESTful installed
pip3 show Flask-RESTful

# 👇️ if you don't have pip setup in PATH
python3 -m pip show Flask-RESTful

# 👇️ uninstall Flask-RESTful
pip3 uninstall Flask-RESTful

# 👇️ if you don't have pip setup in PATH
python3 -m pip uninstall Flask-RESTful

# 👇️ install Flask-RESTful
pip3 install Flask-RESTful

# 👇️ if you don't have pip setup in PATH
python3 -m pip install Flask-RESTful

Try restarting your IDE and development server / script.

You can also try to upgrade the version of the Flask-RESTful package.

Copied!
pip3 install Flask-RESTful --upgrade

# 👇️ if you don't have pip setup in PATH
python3 -m pip install Flask-RESTful --upgrade

This one is for using using virtual environments (VENV) on Windows:

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