typer-cli 0.0.3

Run Typer scripts with completion, without having to create a package, using Typer CLI.

Typer CLI

Run Typer scripts with completion, without having to create a package, using Typer CLI.

---

⚠️ WARNING ⚠️ If you are building a CLI package you probably need Typer, the library itself. This, Typer CLI, is a CLI application that simplifies running simple Typer scripts, it is not the library itself.

Description

Typer is a library for building CLIs (Command Line Interface applications).

Typer CLI (this package) is a CLI application that simplifies running simple programs created with Typer.

Typer CLI's main feature is to provide completion in the Terminal for your own small programs built with Typer, without you having to create a complete installable Python package with them.

It's probably most useful if you have a small custom Python script using Typer (maybe as part of some project), for some small tasks, and it's not complex/important enough to create a whole installable Python package for it (something to be installed with pip).

In that case, you can install Typer CLI, and run your program with the typer command in your Terminal, and it will provide completion for your script.

Usage

Install

Install Typer CLI:

$ python -m pip install typer-cli

That creates a typer command.

You can then install completion for it:

$ typer --install-completion

Sample script

Let's say you have a script that uses Typer in my_custom_script.py:

import typer

app = typer.Typer()


@app.command()
def hello(name: str = None):
    if name:
        typer.echo(f"Hello {name}")
    else:
        typer.echo("Hello World!")


@app.command()
def bye(name: str = None):
    if name:
        typer.echo(f"Bye {name}")
    else:
        typer.echo("Goodbye!")


if __name__ == "__main__":
    app()

Run with Python

Then you could run your script with normal Python:

$ python my_custom_script.py hello

Hello World!

$ python my_custom_script.py hello --name Camila

Hello Camila!

$ python my_custom_script.py bye --name Camila

Bye Camila

There's nothing wrong with running with Python directly. And, in fact, if some other code or program uses your script, that would be the best way to do it.

⛔️ But in your terminal, you won't get completion when hitting TAB for any of the subcommands or options, like hello, bye, and --name.

Run with Typer CLI

Here's where Typer CLI is useful.

You can also run the same script with the typer command you get after installing typer-cli:

$ typer my_custom_script.py run hello

Hello World!

$ typer my_custom_script.py run hello --name Camila

Hello Camila!

$ typer my_custom_script.py run bye --name Camila

Bye Camila

• Instead of using python directly you type typer.
• After the name of the file you add the subcommand run.

✔️ If you installed completion as described above, when you hit TAB you will have autocompletion for everything, including the run and all the subcommands and options of your script, like hello, bye, and --name.

If main

Because Typer CLI won't use the block with:

if __name__ == "__main__":
    app()

You can also remove it if you are calling that script only with Typer CLI (using the typer command).

License

This project is licensed under the terms of the MIT license.