pit-viper

Pit-Viper is a Python package that offers configuration management capabilities like the Viper package in Golang.

Table of Contents

1. Installation

2. Usage

3. Development

Installation

You can install pit-viper using pip:

pip install pit-viper

Usage

Environment Variables

The pit-viper package provides the auto_env function that loads environment variables from a .env file. The function returns a dict of all existing environment variables.

from pit import viper

env = viper.auto_env()

We recommend accessing your environment variables via viper.get.

from pit import viper

# Bind environment variables
viper.auto_env()

bar = viper.get("foo")

With this, you could also useviper.set to specify default parameters up front.

Note: Changes to the environment following the first import of pit-viper will not be reflected in the package's record of environment variables.

Prefixes are commonly being used to prevent name collisions in environment variables. You can specify a prefix as follows:

from pit import viper

viper.set_env_prefix("pf")

# Bind environment variables 
viper.auto_env() # PF_FOO = "bar" 

bar = viper.get("foo") # "bar"

We provide you with the option to overwrite env keys when querying environment variables. For example, you might want to overwrite a . used for retrieving parameters from a config with a _ when accessing environment variables. This can be useful for creating a mapping between env keys and config keys.

from pit import viper

# Bind environment variables 
viper.auto_env() # MY_FOO = "bar" 

viper.set_env_key_replacer({".": "_"})

bar = viper.get("my.foo") # "bar"

Config Files

Config files are another config source for pit-viper. The package supports loading, accessing, and setting defaults for a config. Supported file formats are JSON, TOML, and YAML.

from pathlib import Path
from pit import viper

MY_CONFIG_DIR = Path() / "config"

viper.set_config_path(MY_CONFIG_DIR)
viper.set_config_name("my_config")
viper.set_config_type("toml")

viper.set("foo", "default-value")

viper.load_config()

bar = viper.get("foo")
nested_parameter = viper.get("my.nested.parameter")

Note: After loading the environment varibles with viper.auto_env, every call of viper.get will try to retrieve the parameter from the environment variables before performing a lookup in the parameters of the config file.

Development

We use Poetry for packaging and dependency management. We recommend creating your virtual environment in a directory named .venv in the project's root directory. This ensures that all scripts and git hooks relying on the Python environment will work properly. Therefore, after installing Poetry, consider running the command below to configure Poetry for the present project.

poetry config virtualenvs.in-project true --local 

Afterward, you can run the install command to install the dependencies (including development requirements) specified in the pyproject.toml or poetry.lock file.

poetry install

For a more comprehensive description of the Poetry setup and commands, see their documentation.

The pit-viper package is intended to be PEP 561 compatible. For this reason, we use a pre-commit hook that validates the code on every commit. The code validation runs tests and performs checks using Ruff, Mypy, and Pyright. Execute scripts/setup to add the validation as your pre-commit hook for this project.