pydotenvs

PY.Env

Import environment variables from your .env file or run as command line tool; PyDotEnv Cli.

• Python 3
• Command line tool

Version

Stable: v0.2.0

How to use

pip install pydotenvs

or 

git clone https://github.com/ableinc/pyenv.git
cd pyenv
pip install --editable .

Now import into any python project you have

from pydotenvs import load_env
load_env()

or

load_env('.myEnvFile')

or

envObj = load_env_object()
envObj['myEnv']

# New
envObj = load_env_object(values_as_datatype=True)
envObj['myEnv']

# The example above will return the values in the dictionary as their respective data types.

That's it!

Demo

Run this to see a working example

python example/demo.py

StringIO

You can load your local .env file as a StringIO object. By default you are responsible for closing the StringIO object. Though, there is an option to auto close upon program termination.

from pydotenvs import load_env
stringObj = load_env(stringIO = True, auto_close = True)
contents = stringObj.getvalue()

Transfer

You can now transfer an existing .env file variables to a new .env file, with the option of preserving or overriding the existing values in the new .env file. You can use this feature via the CLI tool or by importing the function from the pydotenvs library. Preserve is True by default. Example:

from pydotenvs import transfer_new_env, load_env
transfer_new_env(old_env_path = '.env', new_env_path = '.env-new', preserve = True)
# load_env('.env-new')

or

pyenv -f .env -n .newenv -t True

Clear

You can clear environment variables during runtime with the clear_env function. You can provide the .env file path or use the default file path. If you've ran a transfer during the current runtime, it will only remove the variables set in the new environment variable file. By default it will only clear the environment variables set in the .env file path provided. Example:

from pydotenvs import clear_env
clear_env(env_path = '.env', module_init_only=True)

Command Line Tool - CLI

You can use PyEnv as a command line tool. All the same features apply. It would be common to use the client tool for the Dictionary & StringIO features of PyEnv.

You can run a command that requires your local environment variables with PyEnv command line tool. Your variables will only exist in that one instance.

 pyenv --command 'echo $MY_VARIABLE'

Usage: pyenv [OPTIONS]

Options:
  -f, --envpath PATH      Location of .env file, defaults to .env in current
                          working directory  [required]
  -n, --newpath PATH      Location of new .env file that you would like to
                          transfer old env file variables to
  -t, --transfer BOOLEAN  This must be true if you would like to transfer.
                          --newpath is required as well.
  -p, --preserve BOOLEAN  True or False whether or not to preserve existing
                          envs during transfer
  -c, --command TEXT      Run a command that requires local enviornment
                          variables for one instance
  -l, --loadobj BOOLEAN   Load .env file as object instead of environment
                          variable
  -s, --stringio BOOLEAN  Load .env file as StringIO object instead of
                          environment variable
  --clear BOOLEAN         Clear the environment variables set by pydotenvs or
                          all variables during runtime.
  -v, --verbose BOOLEAN   Verbose
  --version               Show the version and exit.
  --help                  Show this message and exit.

Changelog

• July 2022 - Minor version update
  • When using load_env_object() you can now return the values as their respective data type. i.e load_env_object('.env', values_as_datatype=True) (Note: default is False. Data types supported are integer, float, dictionary, string, and list.)
  • Squashed some bugs :)
• March 2022 - Minor version udpate
  • Bug fix where 'PWD' key was not found on linux systems.
• January 2022 - Minfor version update
  • You can now transfer an old .env file document to a new .env file document. Described above.
  • Before, the .env file was required at root of the project directory. This is no longer the case, you can now give any file path on the system.
  • Option to clear all environment variables or only the ones imported by pydotenvs - Default: module_init_only=True
• October 2020 - Minor version update
  • Any message that should/shall be printed (unrelated to an error) will be controlled by the boolean value of verbose.
  • Cleaned the CLI code, slightly