typer-config
This is a collection of utilities to use configuration files to set parameters for a 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 and prototyped in this issue. It allows you to set values for CLI parameters using a configuration file.
Installation
$ 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
# 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:
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_configfor those file formats. You can also use your own loader function and the@use_config(loader_func)decorator.
See the documentation for more examples using typer-config.
Metadata
Release files for typer-config 1.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| typer_config-1.5.1.tar.gz | 10.5 kB | Without provenance | Details for typer_config-1.5.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| typer_config-1.5.1-py3-none-any.whl | Python 3 | none | any | Details for typer_config-1.5.1-py3-none-any.whl |
Total release size: 24.0 kB
Release files / typer_config-1.5.1.tar.gz
| Download URL | typer_config-1.5.1.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
78be341f6894f44d6f2dc6b01f6eef83b9381d16c11341b12d6b8a245a3fb451
|
|
BLAKE2b-256 checksum How to use checksums |
2183816a6556bb8f4acaa10e908f609557be00f3df2cae98c4216e4b75235c45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / typer_config-1.5.1-py3-none-any.whl
| Download URL | typer_config-1.5.1-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a13bb7d0043231c58e0ec28195a4f54a08116a48b0d61ca49af13f83ef3a846e
|
|
BLAKE2b-256 checksum How to use checksums |
3be1e51631c3454838faecf73c95dcfbc337654bdef8ac68671973e2ca823265
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for typer-config 1.5.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.