Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Getting Started

essex-config is a Python library for creating configuration objects that read from various sources, including files, environment variables, and Azure Key Vault.

pip install essex-config

Basic Usage

Create a configuration object for connecting to a customer database:

from pydantic import BaseModel, Field
from essex_config import load_config

class CustomerDatabase(BaseModel):
    """Configuration for connecting to the Customer Database"""
    host: str = Field(default="127.0.0.1", description="DB connection host")
    port: int = Field(description="DB connection port")
    password: str = Field(description="DB connection password")

if __name__ == "__main__":
    config = load_config(CustomerDatabase)
    print(config)

When load_config(CustomerDatabase) is executed, values are populated from environment variables or default values.

Nested Configurations

Nest configuration objects:

class Inner(BaseModel):
    inner_hello: str

class NestedConfiguration(BaseModel):
    hello: str
    nested: Inner

nested_config = load_config(NestedConfiguration)

load_config() populates every field, including nested_config.nested.inner_hello. The default prefix for every field in Inner is nested, which can be changed with Annotated[Inner, Prefixed("new_prefix")].

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

essex_config-0.0.6.tar.gz (19.5 kB view details)

Uploaded Jan 28, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

essex_config-0.0.6-py3-none-any.whl (18.4 kB view details)

Uploaded Jan 28, 2025 Python 3

File details

Details for the file essex_config-0.0.6.tar.gz.

File metadata

Download URL: essex_config-0.0.6.tar.gz
Upload date: Jan 28, 2025
Size: 19.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for essex_config-0.0.6.tar.gz
Algorithm	Hash digest
SHA256	`cd8b1859cbb2628a93af16b8edb297f7a608aba53a9a05d776b4834e2f484ded`
MD5	`a7f3402398b03efa19cc23cc6b4948ca`
BLAKE2b-256	`c81b1776b4950fb21b10e3112adce8deef433f20fc1d5c72545884bef90adefb`

See more details on using hashes here.

Provenance

The following attestation bundles were made for essex_config-0.0.6.tar.gz:

Publisher: python-publish.yml on microsoft/essex-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: essex_config-0.0.6.tar.gz
- Subject digest: cd8b1859cbb2628a93af16b8edb297f7a608aba53a9a05d776b4834e2f484ded
- Sigstore transparency entry: 166141490
- Sigstore integration time: Jan 28, 2025
Source repository:
- Permalink: microsoft/essex-toolkit@e0a11e94f56de979a5e9e97f5e1f3af874b8bbd0
- Branch / Tag: refs/heads/main
- Owner: https://github.com/microsoft
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@e0a11e94f56de979a5e9e97f5e1f3af874b8bbd0
- Trigger Event: push