# typer-config
[](https://github.com/maxb2/typer-config/actions/workflows/ci.yml)
[](https://app.codecov.io/gh/maxb2/typer-config)
[](https://pypi.org/project/typer-config/)
[](https://pypi.org/project/typer-config/#history)
[](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.
Raw data
{
"_id": null,
"home_page": "https://maxb2.github.io/typer-config/",
"name": "typer-config",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "typer, config, configuration, configuration-file, yaml, toml, json, dotenv, cli",
"author": "Matt Anderson",
"author_email": "matt@manderscience.com",
"download_url": "https://files.pythonhosted.org/packages/2e/af/78f802bc49eaa5855082cca10e9c9d7d03469c957c149aa159561dc3d744/typer_config-1.4.2.tar.gz",
"platform": null,
"description": "# typer-config\n\n[](https://github.com/maxb2/typer-config/actions/workflows/ci.yml)\n[](https://app.codecov.io/gh/maxb2/typer-config)\n[](https://pypi.org/project/typer-config/)\n[](https://pypi.org/project/typer-config/#history)\n[](https://libraries.io/pypi/typer-config)\n\nThis is a collection of utilities to use configuration files to set parameters for a [typer](https://github.com/tiangolo/typer) CLI.\nIt is useful for typer commands with many options/arguments so you don't have to constantly rewrite long commands.\nThis 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. \n\n## Installation\n\n```bash\n$ pip install typer-config[all]\n```\n\n> **Note**: that will include libraries for reading from YAML, TOML, and Dotenv files as well.\n Feel free to leave off the optional dependencies if you don't need those capabilities.\n\n## Usage\n\n```bash\n# Long commands like this:\n$ my-typer-app --opt1 foo --opt2 bar arg1 arg2\n\n# Can become this:\n$ my-typer-app --config config.yml\n```\n\n## Quickstart\n\nYou can use a decorator to quickly add a configuration parameter to your `typer` application:\n\n```py\nimport typer\nfrom typer_config import use_yaml_config\n\napp = typer.Typer()\n\n\n@app.command()\n@use_yaml_config() # MUST BE AFTER @app.command()\ndef main(foo: FooType): ...\n\n\nif __name__ == \"__main__\":\n app()\n```\n\nYour typer command will now include a `--config CONFIG_FILE` option at the command line.\n\n> **Note**: this package also provides `@use_json_config`, `@use_toml_config`, and `@use_dotenv_config` for those file formats.\n> You can also use your own loader function and the `@use_config(loader_func)` decorator.\n\nSee the [documentation](https://maxb2.github.io/typer-config/latest/examples/simple_yaml/) for more examples using typer-config.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Utilities for working with configuration files in typer CLIs. ",
"version": "1.4.2",
"project_urls": {
"Documentation": "https://maxb2.github.io/typer-config/",
"Homepage": "https://maxb2.github.io/typer-config/",
"Repository": "https://github.com/maxb2/typer-config"
},
"split_keywords": [
"typer",
" config",
" configuration",
" configuration-file",
" yaml",
" toml",
" json",
" dotenv",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfbd2e9d407d7ed3f33a40d8211a481b76a0507ba4f117da9dec116c0de9871e",
"md5": "082d1a6afe54f066a027a0f983f8172c",
"sha256": "b3e1f59bacc8276e5b830f35c9ca403cd85f14173169c23c3756fa816357a34f"
},
"downloads": -1,
"filename": "typer_config-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "082d1a6afe54f066a027a0f983f8172c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 11698,
"upload_time": "2024-11-08T01:59:05",
"upload_time_iso_8601": "2024-11-08T01:59:05.787669Z",
"url": "https://files.pythonhosted.org/packages/df/bd/2e9d407d7ed3f33a40d8211a481b76a0507ba4f117da9dec116c0de9871e/typer_config-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2eaf78f802bc49eaa5855082cca10e9c9d7d03469c957c149aa159561dc3d744",
"md5": "4e66d7f2445b2590c0663f8e2b232e87",
"sha256": "69dffc0e06095b57754bfe9fb3e4caf28ab9c2c430dade6433b0ca128510f600"
},
"downloads": -1,
"filename": "typer_config-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "4e66d7f2445b2590c0663f8e2b232e87",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 10919,
"upload_time": "2024-11-08T01:59:06",
"upload_time_iso_8601": "2024-11-08T01:59:06.635630Z",
"url": "https://files.pythonhosted.org/packages/2e/af/78f802bc49eaa5855082cca10e9c9d7d03469c957c149aa159561dc3d744/typer_config-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 01:59:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxb2",
"github_project": "typer-config",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "typer-config"
}
JSON
