Welcome to bc-configs’s documentation!

Let’s make your configuration easy.

Introduction

bc-configs is a library that makes configuring your applications easier.

Installation

To install, use pip:

pip install bc-configs

Make your custom config class

You can create your custom config class by inheriting from BaseConfig:

import os
from bc_configs import BaseConfig, define

define()

class MyConfig(BaseConfig):
    some_int: int
    some_string: str
    some_bool: bool

my_config = MyConfig()  # type: ignore[call-arg]

assert int(os.getenv("MY_SOME_INT")) == my_config.some_int  # True
assert os.getenv("MY_SOME_STRING") == my_config.some_string  # True
assert bool(os.getenv("MY_SOME_BOOL")) == my_config.some_bool  # True

The name of the environment variable is formed based on the names of the class and field.

Features

• Load environment variables from .env files (using python-dotenv).

• Load environment variables from YAML files (e.g., .env.yml or custom path via YAML_CONFIG_FILE environment variable).

• Load secrets from HashiCorp Vault (using hvac).

Contents:

• Module documentation
  • Configurator
  • Environ Source
  • BaseConfig
  • EnvironSourceException
  • VaultConfig
  • define()
• For contributing
  • Installing environment
  • If you want contributing
  • If you need to build and publish the package
  • How to generate badges?
  • How to build sphinx docs?

Indices and tables

• Index

• Module Index

• Search Page