Package: typer-cloup
Typer, build great CLIs. Easy to code. Based on Python type hints.Documentation:https://typer-cloup.netlify.appSource Code:https://github.com/alexreg/typer-cloupNOTE: This project is a fork ofthe original Typer project, building uponClouprather thanClick(of which Cloup is an extension).typer-cloupis largely but not entirely backward compatible withtyper0.4.2, and also includes some changes totypermade since then.Typer is a library for buildingCLIapplications that users willlove usingand developers willlove creating. Based on Python 3.7+ type hints.The key features are:Intuitive to write: Great editor support.Completioneverywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.Easy to use: It's easy to use for the final users. Automatic help, and automatic completion for all shells.Short: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.Start simple: The simplest example adds only 2 lines of code to your app:1 import, 1 function call.Grow large: Grow in complexity as much as you want, create arbitrarily complex trees of commands and groups of subcommands, with options and arguments.FastAPI of CLIsTyperisFastAPI's little sibling.And it's intended to be the FastAPI of CLIs.RequirementsPython 3.7+Typerstands on the shoulders of a giant. Its only internal dependency isCloup, which is itself based onClick.Installation$pipinstalltyper-cloup---> 100%Successfully installed typer-cloupExampleThe absolute minimumCreate a filemain.pywith:importtyper_cloupastyperdefmain(name:str):typer.echo(f"Hello{name}")if__name__=="__main__":typer.run(main)Run itRun your application:// Run your application$pythonmain.py// You get a nice error, you are missing NAMEUsage: main.py [OPTIONS] NAMETry "main.py --help" for help.Error: Missing argument 'NAME'.// You get a --help for free$pythonmain.py--helpUsage: main.py [OPTIONS] NAMEArguments:NAME    [required]Options:--help  Show this message and exit.// When you create a package you get ✨ auto-completion ✨ for free, installed with --install-completion// Now pass the NAME argument$pythonmain.pyCamilaHello Camila// It works! 🎉Note: auto-completion works when you create a Python package and run it with--install-completionor when you useTyper CLI.Example upgradeThis was the simplest example possible.Now let's see one a bit more complex.An example with two subcommandsModify the filemain.py.Create atyper.Typer()app, and create two subcommands with their parameters.importtyper_cloupastyperapp=typer.Typer()@app.command()defhello(name:str):typer.echo(f"Hello{name}")@app.command()defgoodbye(name:str,formal:bool=False):ifformal:typer.echo(f"Goodbye Ms.{name}. Have a good day.")else:typer.echo(f"Bye{name}!")if__name__=="__main__":app()And that will:Explicitly create atyper.Typerapp.The previoustyper.runactually creates one implicitly for you.Add two subcommands with@app.command().Execute theapp()itself, as if it was a function (instead oftyper.run).Run the upgraded example// Check the --help$pythonmain.py--helpUsage: main.py [OPTIONS] COMMAND [ARGS]...Options:--help  Show this message and exit.Commands:goodbyehello// You have 2 subcommands (the 2 functions): goodbye and hello// Now get the --help for hello$pythonmain.pyhello--helpUsage: main.py hello [OPTIONS] NAMEArguments:NAME    [required]Options:--help  Show this message and exit.// And now get the --help for goodbye$pythonmain.pygoodbye--helpUsage: main.py goodbye [OPTIONS] NAMEArguments:NAME                    [required]Options:--formal / --no-formal  [default: no-formal]--help                  Show this message and exit.// Automatic --formal and --no-formal for the bool option 🎉// And if you use it with the hello command$pythonmain.pyhelloCamilaHello Camila// And with the goodbye command$pythonmain.pygoodbyeCamilaBye Camila!// And with --formal$pythonmain.pygoodbye--formalCamilaGoodbye Ms. Camila. Have a good day.RecapIn summary, you declareoncethe types of parameters (CLI argumentsandCLI options) as function parameters.You do that with standard modern Python types.You don't have to learn a new syntax, the methods or classes of a specific library, etc.Just standardPython 3.7+.For example, for anint:total:intor for aboolflag:force:boolAnd similarly forfiles,paths,enums(choices), etc. And there are tools to creategroups of subcommands, add metadata, extravalidation, etc.You get: great editor support, includingcompletionandtype checkseverywhere.Your users get: automatic--help,auto-completionin their terminal (Bash, Zsh, Fish) when they install your package or when usingTyper CLI.For a more complete example including more features, see theTutorial - User Guide.Optional DependenciesTyper usesCloupinternally, which is based onClick. That's the only dependency.But you can also install extras:colorama: and Click will automatically use it to make sure your terminal's colors always work correctly, even in Windows.Then you can use any tool you want to output your terminal's colors in all the systems, including the integratedtyper.style()andtyper.secho()(provided by Click).Or any other tool, e.g.wasabi,blessings.docstring_parser: and Typer will automatically use it to parse help text for parameters from docstrings of functions.You can installtyper-cloupwith all optional dependencies by runningpip install typer-cloup[all].Other tools and plug-insClick has many plug-ins available that you can use. And there are many tools that help with command-line applications that you can use as well, even if they are not related to Typer or Click.For example:click-spinner: to show the user that you are loading data. A Click plug-in.There are several other Click plug-ins atclick-contribthat you can explore.tabulate: to automatically display tabular data nicely. Independent of Click or Typer.tqdm: a fast, extensible progress bar, alternative to Typer's owntyper.progressbar().LicenseThis project is licensed under the terms of the MIT license.