Skip to main content

A universal configuration parser for Python.

Project description

configmate: universal, practical configuration parser for Python.

With support for multiple file format backends, this package provides robust validation and allows for configuration overrides. Engineered for straightforward and reliable integration into Python applications.

Key Features:

  • Support for Multiple File Formats: ConfigMate supports JSON, YAML, TOML and XML formats.
  • Overrides: Allows for easy management of multiple config_files.
  • Environment Variable Interpolation using the syntax ${VAR_NAME:default_value}.

Example:

Let's say you have a Python app that needs to be deployed in multiple environments. You want to be able to configure the application using config files, but you also want to be able to override certain settings in the production environment:

// config.json (This is the default configuration file.)
{
    "db": "DEV",
    "port": "${PORT:8080}" // default to 8080 if PORT is not set in env
}

// prod_config.json (overrides certain settings in the prod environment.)
{
    "db": "PROD", // overrides db in prod deployment
}

Here's how you use configmate to load and validate these configurations in a Python application:

# app.py
import configmate
import pydantic


class Config(pydantic.BaseModel):
    db: str
    port: int


config = configmate.get_config(
    "config.json",  # main config
    "prod_config.json",  # prod overlay
    validation=lambda kwargs: Config(**kwargs),
)

print(config)

Now, when you run the application, the configuration files are parsed in order and you can override the port using an environment variable:

PORT=9000 python app.py
## db='PROD' port=9000

Project details


Download files

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

Source Distribution

configmate-0.1.5.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

configmate-0.1.5-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file configmate-0.1.5.tar.gz.

File metadata

  • Download URL: configmate-0.1.5.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/23.2.0

File hashes

Hashes for configmate-0.1.5.tar.gz
Algorithm Hash digest
SHA256 7aac5042826b1b7bde1cfc3426138638ca1e3474af3146960433fe46272f81fb
MD5 3c6050dc18cd7e277713ba0faa870580
BLAKE2b-256 caa9227165f91b2332dac61e1e0a36a08b2dd7f3782c884b2e4ced8e949a1eba

See more details on using hashes here.

File details

Details for the file configmate-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: configmate-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/23.2.0

File hashes

Hashes for configmate-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 dafc08cb209d3d102506781d641ab0adb88f88f04dc27c9c14af7b23596854cb
MD5 abcf102b697c01240aedd2735f5cbdfe
BLAKE2b-256 f188a9dafecd95533d701b6ab8435f4d6e953e6827ca08d7c064ce9a7858ccbf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page