Maison

Read configuration settings from configuration files.

📚 View Documentation | 🐛 Report a Bug | ✨ Request a Feature

Motivation

When developing a python package, e.g a command-line tool, it can be helpful to allow the user to set their own configuration options to allow them to tailor the tool to their needs. These options are typically set in files in the root of a user's directory that uses the tool, for example in a pyproject.toml or an {project_name}.ini file.

maison aims to provide a simple and flexible way to read and validate those configuration options so that they may be used in the package.

Features

Supports multiple config files and multiple config filetypes.
Optional merging of multiple configs.
Optional config validation with pydantic.
Caching of config files for quick access.
Fully tested and typed.

Installation

You can install maison via pip from PyPI:

pip install maison

Installation for Development

To set up maison for local development:

Clone the repository:

git clone https://github.com/dbatten/maison.git
cd maison

Install dependencies using :term:uv:
```
uv sync
```
Install pre-commit hooks:
```
uvx nox -s pre-commit -- install
```

This sets up a virtual environment and installs core, development, and quality check dependencies.

Usage

Suppose the following pyproject.toml lives somewhere in a user's directory:

[tool.acme]
enable_useful_option = true

maison exposes a UserConfig class to retrieve values from config files like so:

from maison import UserConfig

from my_useful_package import run_useful_action

config = UserConfig(package_name="acme")

if config.values["enable_useful_option"]:
    run_useful_action()

Development Workflow

This project uses a robust set of tools for development, testing, and quality assurance. All significant automated tasks are run via :term:Nox, orchestrated by the central noxfile.py.

Run all checks (lint, typecheck, security): uvx nox -s check
Run test suite with coverage: uvx nox -s test
Build documentation: uvx nox -s docs
Build package: uvx nox -s build
See all available tasks: uvx nox -l

Explore the noxfile.py and the project documentation for detailed information on the automated workflow.

Contributing

(This section should guide contributions to this specific generated project, not the template. It should refer to the project's CODE_OF_CONDUCT.md and link to a CONTRIBUTING.md specific to the project, if you choose to generate one.)

Report bugs or suggest features via the issue tracker.

See CONTRIBUTING.md for contribution guidelines.