Skip to content

Module to manage Windows environment variables. Permanently add/delete/modify user or system vars.

License

Notifications You must be signed in to change notification settings

beliaev-maksim/py_setenv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

Command Line Application and Python Package to Add/Append/Remove environment variables on Windows systems
Current package allows to precisely control and differentiate user and system variables

Table of Contents

  1. Installation
  2. CLI
    1. Get variable
    2. Create/Replace variable
    3. Append to existing variable
    4. Delete variable
    5. List all variables
  3. Python Package
    1. Get variable
    2. Create/Replace variable
    3. Append to existing variable
    4. Delete variable
    5. List all variables

Installation

To install the package you need to run

python -m pip install py-setenv

How to use as CLI application

Get variable (CLI)

Get value of variable my_var

:: User environment
setenv my_var -u
:: System environment
setenv my_var

Create/replace variable (CLI)

Set variable my_var to 1

:: User environment
setenv my_var -v 1 -u

:: System environment
setenv my_var -v 1

Append to existing variable (CLI)

Append my/test/dir to path variable

:: User environment
setenv path -v my/test/dir -a -u

:: System environment
setenv path -v my/test/dir -a 

Delete variable (CLI)

Delete variable my_var

:: User environment
setenv my_var -d -u

:: System environment
setenv my_var -d

List all variables (CLI)

Lists all variables

:: User environment
setenv -l

:: System environment
setenv -l

How to use as Python package

Get variable

Get value of variable my_var

from py_setenv import setenv
setenv("my_var")

Create/replace variable

Set variable my_var to 1

from py_setenv import setenv
setenv("my_var", value=1, user=True)

Append to existing variable

Append my/test/dir to path variable

from py_setenv import setenv
setenv("path", value="my/test/dir", append=True, user=True)

Delete variable

Delete variable my_var

from py_setenv import setenv
setenv("my_var", delete=True, user=True)

List all variables

Lists all variables

from py_setenv import setenv
setenv(list_all=True)

# to suppress echo to console
setenv(list_all=True, suppress_echo=True)

About

Module to manage Windows environment variables. Permanently add/delete/modify user or system vars.

Topics

Resources

License

Stars

Watchers

Forks

Languages