https://github.com/maxb2/typer-config

Utilities for working with configuration files in typer CLIs.
https://github.com/maxb2/typer-config

click config configuration configuration-file configuration-management python toml typer typer-cli yaml

Last synced: about 2 months ago
JSON representation

Utilities for working with configuration files in typer CLIs.

• Host: GitHub
• URL: https://github.com/maxb2/typer-config
• Owner: maxb2
• License: mit
• Created: 2023-05-01T15:54:21.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-22T23:34:44.000Z (2 months ago)
• Last Synced: 2026-02-23T04:24:13.737Z (2 months ago)
• Topics: click, config, configuration, configuration-file, configuration-management, python, toml, typer, typer-cli, yaml
• Language: Python
• Homepage: https://maxb2.github.io/typer-config/
• Size: 2.82 MB
• Stars: 37
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# typer-config

[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/maxb2/typer-config/ci.yml?branch=main&style=flat-square)](https://github.com/maxb2/typer-config/actions/workflows/ci.yml)

[![Codecov](https://img.shields.io/codecov/c/github/maxb2/typer-config?style=flat-square)](https://app.codecov.io/gh/maxb2/typer-config)

[![PyPI](https://img.shields.io/pypi/v/typer-config?style=flat-square)](https://pypi.org/project/typer-config/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/typer-config?style=flat-square)](https://pypi.org/project/typer-config/#history)

[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/pypi/typer-config?style=flat-square)](https://libraries.io/pypi/typer-config)

This is a collection of utilities to use configuration files to set parameters for a [typer](https://github.com/tiangolo/typer) CLI.

It is useful for typer commands with many options/arguments so you don't have to constantly rewrite long commands.

This package was inspired by [phha/click_config_file](https://github.com/phha/click_config_file) and prototyped in [this issue](https://github.com/tiangolo/typer/issues/86#issuecomment-996374166). It allows you to set values for CLI parameters using a configuration file. 

## Installation

```bash

$ pip install typer-config[all]

```

> **Note**: that will include libraries for reading from YAML, TOML, and Dotenv files as well.

  Feel free to leave off the optional dependencies if you don't need those capabilities.

## Usage

```bash

# Long commands like this:

$ my-typer-app --opt1 foo --opt2 bar arg1 arg2

# Can become this:

$ my-typer-app --config config.yml

```

## Quickstart

You can use a decorator to quickly add a configuration parameter to your `typer` application:

```py

import typer

from typer_config import use_yaml_config

app = typer.Typer()

@app.command()

@use_yaml_config()  # MUST BE AFTER @app.command()

def main(foo: FooType): ...

if __name__ == "__main__":

    app()

```

Your typer command will now include a `--config CONFIG_FILE` option at the command line.

> **Note**: this package also provides `@use_json_config`, `@use_toml_config`, and `@use_dotenv_config` for those file formats.

> You can also use your own loader function and the `@use_config(loader_func)` decorator.

See the [documentation](https://maxb2.github.io/typer-config/latest/examples/simple_yaml/) for more examples using typer-config.