{"id":35032263,"url":"https://github.com/maxb2/typer-config","last_synced_at":"2026-03-01T06:11:08.000Z","repository":{"id":160042546,"uuid":"634943524","full_name":"maxb2/typer-config","owner":"maxb2","description":"Utilities for working with configuration files in typer CLIs.","archived":false,"fork":false,"pushed_at":"2026-02-22T23:34:44.000Z","size":2955,"stargazers_count":37,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-23T04:24:13.737Z","etag":null,"topics":["click","config","configuration","configuration-file","configuration-management","python","toml","typer","typer-cli","yaml"],"latest_commit_sha":null,"homepage":"https://maxb2.github.io/typer-config/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxb2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["maxb2"],"ko_fi":"maxb2"}},"created_at":"2023-05-01T15:54:21.000Z","updated_at":"2026-02-22T23:34:42.000Z","dependencies_parsed_at":"2026-01-12T20:03:18.937Z","dependency_job_id":null,"html_url":"https://github.com/maxb2/typer-config","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/maxb2/typer-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxb2%2Ftyper-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxb2%2Ftyper-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxb2%2Ftyper-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxb2%2Ftyper-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxb2","download_url":"https://codeload.github.com/maxb2/typer-config/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxb2%2Ftyper-config/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29962004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T05:59:08.471Z","status":"ssl_error","status_checked_at":"2026-03-01T05:58:04.208Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["click","config","configuration","configuration-file","configuration-management","python","toml","typer","typer-cli","yaml"],"created_at":"2025-12-27T07:15:32.966Z","updated_at":"2026-03-01T06:11:07.988Z","avatar_url":"https://github.com/maxb2.png","language":"Python","readme":"# typer-config\n\n[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/maxb2/typer-config/ci.yml?branch=main\u0026style=flat-square)](https://github.com/maxb2/typer-config/actions/workflows/ci.yml)\n[![Codecov](https://img.shields.io/codecov/c/github/maxb2/typer-config?style=flat-square)](https://app.codecov.io/gh/maxb2/typer-config)\n[![PyPI](https://img.shields.io/pypi/v/typer-config?style=flat-square)](https://pypi.org/project/typer-config/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/typer-config?style=flat-square)](https://pypi.org/project/typer-config/#history)\n[![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)\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\u003e **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\u003e **Note**: this package also provides `@use_json_config`, `@use_toml_config`, and `@use_dotenv_config` for those file formats.\n\u003e 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.","funding_links":["https://github.com/sponsors/maxb2","https://ko-fi.com/maxb2"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxb2%2Ftyper-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxb2%2Ftyper-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxb2%2Ftyper-config/lists"}