Typer-Config

1.5.1 · active · verified Wed Apr 15

Typer-Config is a collection of utilities that enable Typer CLI applications to utilize configuration files for setting command parameters. This is particularly useful for CLIs with numerous options and arguments, reducing the need to repeatedly type long commands. It supports various formats including YAML, JSON, TOML, and Dotenv. The current version is 1.5.1, and it typically follows the release cadence of its dependencies or as new features/fixes are required.

Warnings

gotcha When using configuration decorators like `@use_yaml_config()`, they must be placed *after* the `@app.command()` decorator on the function definition. Incorrect placement will prevent the configuration from being loaded and applied correctly.
Fix: Ensure the `@use_yaml_config()` (or similar) decorator is applied beneath `@app.command()`.
gotcha When providing a custom loader function to `@use_config()`, ensure it gracefully handles cases where no config file path is provided or the file doesn't exist. Otherwise, the CLI might raise an error during `--help` output or when the `--config` option is omitted, leading to a poor user experience.
Fix: Implement a conditional check within your custom loader function to return an empty dictionary or handle `None` for the config path gracefully if no file is meant to be loaded.
gotcha Optional dependencies for specific config formats (e.g., `PyYAML` for YAML) are not automatically installed with `pip install typer-config`. If you intend to use a particular format, you must install the corresponding optional dependencies using `pip install typer-config[format_name]` or `typer-config[all]`.
Fix: Install `typer-config` with the required extras, e.g., `pip install typer-config[yaml]` for YAML support.

Install

pip install typer-config Base installation
pip install typer-config[all] With all optional dependencies (YAML, TOML, Dotenv)
pip install typer-config[yaml] With YAML support
pip install typer-config[toml] With TOML support
pip install typer-config[dotenv] With Dotenv support

Imports

use_yaml_config

from typer_config import use_yaml_config

use_json_config

from typer_config import use_json_config

use_toml_config

from typer_config import use_toml_config

use_dotenv_config

from typer_config import use_dotenv_config

use_config
```
from typer_config import use_config
```

Quickstart

This quickstart demonstrates how to integrate `typer-config` using the `@use_yaml_config()` decorator. Create a `config.yml` file in the same directory with `name: Alice` and `age: 30`. Run the script with `python your_script.py` or `python your_script.py --config config.yml`. The parameters `name` and `age` will be populated from the config file, which can be overridden by command-line arguments.

import typer
from typer_config import use_yaml_config
from typing import Optional

app = typer.Typer()

@app.command()
@use_yaml_config()
def main(
    name: str = "World",
    age: Optional[int] = None,
    config_file: Optional[str] = typer.Option(None, hidden=True) # Added for registry example clarity
):
    """A simple CLI app using a YAML config file."""
    print(f"Hello, {name}!")
    if age:
        print(f"You are {age} years old.")
    if config_file:
        print(f"Using config file: {config_file}")

if __name__ == "__main__":
    # Example config.yml content (create this file for testing):
    # name: Alice
    # age: 30
    app()

view raw JSON →