Set environment variables when activating python virtual environment in windows

Question

I want to be able to set up environment variables in my virtual environment so that they are available in my code when I activate the virtual environment. I make my virtual enviornments with venv. I'm working on a Windows machine with VS-code.

What I already tried, but didn't work.

Adding the vars to end of the activate.bat file like this:

set CLIENT_SECRET="MYSECRET"

Adding the vars to the end of the Activate.ps1 file like this:

$CLIENT_SECRET="MYSECRET"

Adding the vars to the end of the activate file like this:

export CLIENT_SECRET="MYSECRET"

I found a lot related to my topic, but none working for me. What to do?

It's not having difficulties finding my environment, it's just not loading the vars. I used to work in Pycharm, which I really like, but changed to VS Code since it has a lot of free plugins/supports more languages compared to the Community Version of Pycharm. Maybe, it's time to get out the wallet... :) — Monkey Pylot
– Monkey Pylot, Commented Dec 16, 2019 at 9:04
If you liked PyCharm (I do as well), but you need broad support for many languages, you could consider IntelliJ - I am curious what languages you think PyCharm does not support as an editor, that VSCode would though. Often the answer is 'there is a plugin for that'. But IntelliJ will have you covered for full-featured support of most languages - as will other similar platforms like Visual Studio for example. — Grismar
– Grismar, Commented Dec 16, 2019 at 10:54

makozaki · Accepted Answer · 2019-12-17 07:52:50Z

7

If you want to setup your development environment in VSCode you can simply add .env file with all secrets defined in project root directory. More details in docs

edited Dec 17, 2019 at 7:52

answered Dec 16, 2019 at 7:30

makozaki

4,4367 gold badges31 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Monkey Pylot Over a year ago

I gave this a shot, but also this does not seem to work. I placed a file named dev.env in my project root folder with the following var assignment CLIENT_SECRET=MYSECRET

makozaki Over a year ago

How are you running your script? If you want to load environment automatically you need to use VSCode debugger with its configuration. By default just hit F5 or Debug -> Start Debugging, on your python file and VSCode will load environment from .dev file.

Monkey Pylot Over a year ago

I tried in debug mode, but also direct in my terminal. Maybe I'm calling the vars the wrong way, how should I call them in my code?

makozaki Over a year ago

Python: 'os.environ.get("CLIENT_SECRET")'

Brett Cannon Over a year ago

If you name your environment definition file something other than .env you will need to set the appropriate setting to point to the file such as the "python.envFile" setting.

|

jorop · Accepted Answer · 2019-12-13 16:00:27Z

3

Your first solution

set CLIENT_SECRET=MYSECRET

in activate.batshould work, when using Command Prompt in the terminal as Default Shell.

You can omit the quotes unless they are part of your envirionment variable.

You can verify, if the environment variable is set with:

echo %CLIENT_SECRET% in the terminal in VS-Code.

answered Dec 13, 2019 at 16:00

jorop

5434 silver badges4 bronze badges

2 Comments

Monkey Pylot Over a year ago

Ok, it indeed works. However, it only works when i'm running it in Python Interactive and not when I'm running it in the terminal. Also, your suggested code to echo the var is not working for me.

mike rodent 2 days ago

Yes, works for me. One slight oddity: when you DEactivate in W10, that env var will remain set for the duration of the command prompt session. In other words, deactivating does not get rid of the VE-specific env var. If needed you can achieve this in W10 by set my_env_var = (i.e. set to nothing) in deactivate.bat in the VE files. In Linux you don't (and can't) do this: deactivate should restore the underlying "real" environment, including env vars as they were previously.

blokeish · Accepted Answer · 2024-01-31 23:53:18Z

2

The default Terminal that popped up for me in VS Code was the PowerShell, which I didn't realize at first. I had to use:

To write the env variable

$Env:MYAPP_DB_USER = "myapp_user"

To read the env variable

$Env:MYAPP_DB_USER

NB: '$' in front is part of the command. 'MYAPP_DB_USER' is the Key and 'myapp_user' is the Value I don't want to keep the passwords and keys as part of the code (including .env file) and have it pushed to the git repo and the server.

Ref: Microsoft PowerShell - Env variables

answered Jan 31, 2024 at 23:53

blokeish

6366 silver badges9 bronze badges

Comments

ashish bindra · Accepted Answer · 2022-04-02 03:33:53Z

0

go to endowment variable folder enter Script folder now activate with cmd

answered Apr 2, 2022 at 3:33

ashish bindra

594 bronze badges

Comments

desertnaut · Accepted Answer · 2023-05-22 18:30:57Z

-1

use set in CMD teminal

use env: in powershell

edited May 22, 2023 at 18:30

desertnaut

60.8k32 gold badges155 silver badges183 bronze badges

answered May 10, 2022 at 12:06

Raoul Zachary

1

1 Comment

mike rodent Nov 16 at 21:34

This is how you set a env variable in a VE. But the question is about how you PRESERVE that env variable from one activation to the next. Normally they DISAPPEAR when the VE is deactivated.

Collectives™ on Stack Overflow

Set environment variables when activating python virtual environment in windows

5 Answers 5

6 Comments

2 Comments

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

6 Comments

2 Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related