Django Rest Framework — no module named rest_framework

The error message "No module named 'rest_framework'" indicates that Django Rest Framework (DRF) is not installed in your Python environment. To resolve this issue, you need to install DRF. Here are the steps to do so:

Step 1: Install Django Rest Framework

First, ensure you have pip installed. Then, you can install Django Rest Framework using pip. Run the following command in your terminal or command prompt:

pip install djangorestframework

Step 2: Verify Installation

After installation, you can verify that DRF is installed by running:

pip show djangorestframework

This command should display information about the installed package.

Step 3: Add 'rest_framework' to INSTALLED_APPS

Next, you need to add 'rest_framework' to the INSTALLED_APPS list in your Django project's settings.py file:

# settings.py
INSTALLED_APPS = [
    # Other installed apps
    'rest_framework',
]

Step 4: Migrate Database (if needed)

If this is the first time you're setting up DRF in your project, you may need to run database migrations:

  python manage.py migrate

Step 5: Start Using DRF

You can now start using Django Rest Framework in your Django project. Here’s a simple example of how to create an API view :

# views.pyfrom rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class HelloWorld(APIView):
    def get(self, request):
        return Response({"message": "Hello, world!"}, status=status.HTTP_200_OK)

Don't forget to add the appropriate URL pattern to your urls.py:

  # urls.pyfrom django.urls import pathfrom .views import HelloWorldurlpatterns = [    path('hello/', HelloWorld.as_view(), name='hello_world'),]

Common Issues and Solutions

Virtual Environment: Ensure you are using the correct Python environment. If you are using a virtual environment, activate it before installing DRF:

  source venv/bin/activate   # On Linux/Mac.envScriptsctivate    # On Windows

Permissions: If you encounter permission errors during installation, try using pip with --user flag or sudo (on Unix systems):

pip install --user djangorestframework
# or
sudo pip install djangorestframework

Following these steps should resolve the "No module named 'rest_framework'" error and get you started with Django Rest Framework.