DEV Community

Cover image for Using .env Files for Environment Variables in Python Applications

Using .env Files for Environment Variables in Python Applications

Jake Witcher on December 24, 2020

Applications are made to be deployed. At some point during development you will need to think about the environment in which your application will ...
Collapse
 
navporky profile image
NK • Edited

Hi Jake,

I am a noob, trying to learn python along with good practices. Now the queries: The official python-dotenv documentation talks about using the dotenv alongside settings module (python-settings). The load_dotenv() function is also recommended to be put in settings.py. Unable to wrap my head around the following:

  1. Though you have not advised it, why is it advised by many to use both? wouldn't load_dotenv work in any .py file?
  2. While going to pipenv shell for the project, the .env file is automatically loaded. What loads the settings.py file (which has code to load dotenv)?
  3. if .env is excluded from git via .gitignore then, is the other team developer/ tester support to make his own while looking at settings.py for what all values could have been there? and only after the error of not finding the .env file is encountered/ reading the readme.md file?
  4. In production, the environment variables are recommended to set at OS level? Why not in the same .env file, which can be manually created?
  5. For any environment - dev/ test/ production, the code could be written to produce a template .env file with just keys (Key=) and user (dev/ tester, prod) team member can just fill the value in before using. Is this not workable and logical way to do this?
  6. Just looked at python-decouple (as an alternate to python-settings) , won't this is even better as it can handle datatypes as well?

Thanks.

Collapse
 
hirushaadi profile image
Hirusha Adikari
  1. i think load_dotenv() would be enough (it always works on linux, where you would normally deploy a web app)
  2. you will have to import it manually and use. for testing of that file by running it directly, you can put it under if name == "main"
  3. you can add it to the docs of the program and keep a .env.example file filled with dummy values or no values at all (with just the structure)
  4. its secure to keep it away from application's code and config files. doing this, you can ensure that the data is only accessible to the application and not to other users or processes on the same machine
  5. haven't tried it
Collapse
 
ilija profile image
ilija

Tnx for article! But there is one important caveat here: if you use Linux for example you can not use env names like HOME or NAME or LOGNAME. Because your app variables from .env file (in currently working directory) will be overwritten by the global (from Linux).

For example: in case you put in .env NAME=Michale and you are logged in as user Daniel, inside your python script os.getenv("NAME") will return Daniel instead of Michael. And most probably this is not something you want in your app....

I guess there is different ways to resolve this, but most obvious one for me is to avoid this names entirely and to use some convention like APP_NAME or APP_HOME_DIR....

Collapse
 
kmistele profile image
Kyle Mistele

This is a great way to store API keys or other secrets so that they’re not hard coded into your application!

Collapse
 
jakewitcher profile image
Jake Witcher

Absolutely! Thanks for pointing that out. A .env file is a great way to work on a project with those kinds of security concerns in mind without the overhead of storing that information as a system environment variable on your computer.

Collapse
 
10codedev profile image
10CodeDev

Really nice writeup! I was just playing around with Python-DotEnv today.

Collapse
 
jakewitcher profile image
Jake Witcher

Thanks! While it is a very lightweight package, there’s more to it than I initially realized. I’ve primarily used it as described in the article but it does have features that allow for a few other use cases.

Collapse
 
mrhili profile image
Mrhili Mohamed Amine

no pip install needed ?

Collapse
 
mrhili profile image
Mrhili Mohamed Amine

pip install python-dotenv

Collapse
 
lico profile image
SeongKuk Han

Thank you so much!

Collapse
 
pradeepb28_ profile image
deepu

my python script and .env file are in the same folder but somehow it is unable to read the file unless I specify the path.

Collapse
 
cincybc profile image
CincyBC

If you use an Anaconda environment, you can set environment variables in the Conda environment without needing .env files!

Collapse
 
tazim404 profile image
Tazim Rahbar

Is there any way to add new environment variable into .env file from python code.

Collapse
 
thierrynjike profile image
Thierry Njike • Edited

you can write inside using this

with open("$path/to/.env", 'a+') as newenv:
    newenv.write("\n$varname=$varvalue")
load_dotenv()           #load vars again to consider the new added one

Enter fullscreen mode Exit fullscreen mode
Collapse
 
shijoshaji profile image
Shijo Shaji

Thanks, had a chance to try this today

Collapse
 
brunofariasdo profile image
Bruno de Oliveira

It helped me a lot, thank you!