ModuleNotFoundError: No module named ‘environ’

In Python, ModuleNotFoundError: No module named ‘environ’ error occurs if we try to import the ‘django-environ‘ module without installing the package or if you have not installed it in the correct environment.

In this tutorial, let’s look at installing the django-environ module correctly in different operating systems and solve ModuleNotFoundError: No module named ‘environ’ error.  

What is ModuleNotFoundError: No module named ‘environ’?

There are various reasons why we get the ModuleNotFoundError: No module named ‘environ’ error

  • Trying to use the module- without installing the django-environ package.
  • If the IDE is set to the incorrect version of the Python/Python interpreter.
  • You are using the virtual environment and the django-environ module is not installed inside a virtual environment
  • Installing the django-environ package in a different version of Python than the one which is used currently.
  • Declaring a variable name as the module name(django-environ)

If you are getting an error installing pip, checkout pip: command not found to resolve the issue.

How to fix ModuleNotFoundError: No module named ‘environ’?

django-environ is not a built-in module (it doesn’t come with the default python installation) in Python; you need to install it explicitly using the pip installer and then use it.  

django-environ is the Python package that allows you to use Twelve-factor methodology to configure your Django application with environment variables.

We can fix the error by installing the ‘django-environ‘ module by running the pip install django-environ command in your terminal/shell.

We can verify if the package is installed correctly by running the following command in the terminal/shell.

This will provide the details of the package installed, including the version number, license, and the path it is installed. If the module is not installed, you will get a warning message in the terminal stating WARNING: Package(s) not found: django-environ.

pip show django-environ

Output

Name: django-environ
Version: 0.9.0
Summary: A package that allows you to utilize 12factor inspired environment variables to configure your Django application.
Home-page: https://django-environ.readthedocs.org
Author: Daniele Faraglia
Author-email: daniele.faraglia@gmail.com
License: MIT
Location: c:\personal\ijs\python_samples\venv\lib\site-packages

Solution 1 – Installing and using the django-environ module in a proper way

Based on the Python version and the operating system you are running, run the relevant command to install the django-environ module.

# If you are using Python 2 (Windows)
pip install django-environ

# if you are using Python 3 (Windows)
pip3 install django-environ

# If the pip is not set as environment varibale PATH
python -m pip install django-environ

# If you are using Python 2 (Linux)
sudo pip install django-environ

# if you are using Python 3 (Linux)
sudo pip3 install django-environ

# In case if you have to easy_install
sudo easy_install -U django-environ

# On Centos
yum install django-environ

# On Ubuntu
sudo apt-get install django-environ

# If you are installing it in Anaconda 
conda install -c conda-forge django-environ

Create a .env file in the project root directory. The file format can be understood from the example below:

DEBUG=on
SECRET_KEY=your-secret-key
DATABASE_URL=psql://user:un-githubbedpassword@127.0.0.1:8458/database
SQLITE_URL=sqlite:///my-local-sqlite.db
CACHE_URL=memcache://127.0.0.1:11211,127.0.0.1:11212,127.0.0.1:11213
REDIS_URL=rediscache://127.0.0.1:6379/1?client_class=django_redis.client.DefaultClient&password=ungithubbed-secret

Once you have installed the django-environ module, we can now import it inside our settings.py file and use it as shown below.

import environ
import os

env = environ.Env(
    # set casting, default value
    DEBUG=(bool, False)
)

# Set the project base directory
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# Take environment variables from .env file
environ.Env.read_env(os.path.join(BASE_DIR, '.env'))

# False if not in os.environ because of casting above
DEBUG = env('DEBUG')

# Raises Django's ImproperlyConfigured
# exception if SECRET_KEY not in os.environ
SECRET_KEY = env('SECRET_KEY')

Solution 2 – Verify if the IDE is set to use the correct Python version

If you are still getting the same error even after installing the package, you can verify if the IDE you are using is configured with the correct version of the Python interpreter.

For Eg:- In the case of Visual Studio Code, we can set the Python version by pressing CTRL + Shift + Por ( + Shift + P on Mac) to open the command palette.

Once the command palette opens, select the Python interpreter and select the correct version of Python and also the virtual environment(if configured) as shown below.

Image 1

Python Interpreter

Solution 3 – Installing django-environ inside the virtual environment

Many different IDEs like Jupyter Notebook, Spyder, Anaconda, or PyCharm often install their own virtual environment of Python to keep things clean and separated from your global Python.

If you are using VS Code, then you can also create a virtual environment, as shown below.

In the case of virtual environments, you need to ensure that the django-environ module needs to be installed inside the virtual environment and not globally.

Step 1: Create a Virtual Environment. If you have already created a virtual environment, then proceed to step 2.

Step 2: Activate the Virtual Environment

Step 3: Install the required module using the pip install command

# Create a virtual Environment
py -3 -m venv venv

# Activate the virtual environment (windows command)
venv\Scripts\activate.bat

# Activate the virtual environment (windows powershell)
venv\Scripts\Activate.ps1

# Activate the virtual environment (Linux)
source venv/bin/activate

# Install django-environ inside the virtual environment
pip install django-environ

Solution 4 – Ensure that a module name is not declared name a variable name.

Last but not least, you may need to cross-check and ensure that you haven’t declared a variable with the same name as the module name.

You should check if you haven’t named any files as environ.py as it may shadow the original django-environ module.

If the issue is still not solved, you can try removing the package and installing it once again, restart the IDE, and check the paths to ensure that packages are installed in the correct environment path and Python version.

Conclusion

The ModuleNotFoundError: No module named ‘environ’ error occurs when we try to import the ‘django-environ‘ module without installing the package or if you have not installed it in the correct environment.

We can resolve the issue by installing the django-environ module by running the pip install django-environ command. Also, ensure that the module is installed in the proper environment in case you use any virtual environments, and the Python version is appropriately set in the IDE that you are running the code.

Leave a Reply

Your email address will not be published.

Sign Up for Our Newsletters

Subscribe to get notified of the latest articles. We will never spam you. Be a part of our ever-growing community.

You May Also Like
Numpy Transpose

NumPy Transpose

Table of Contents Hide NumPy Transpose SyntaxNumPy Transpose ParametersNumPy Transpose Return ValueExample 1: How to transpose NumPy array in Python?Example 2: Transpose the NumPy array with an axesExample 3 –…
View Post
Python List Clear()

Python List clear()

Table of Contents Hide Syntax of List clear() clear() ParametersReturn Value from List clear()Example 1: Working of clear() methodExample 2: Emptying the List Using del Python List clear() is a built-in function…
View Post