Typer (Slim)

0.24.0 · abandoned · verified Sat Mar 28

Typer-slim was initially conceived as a minimal version of the Typer library for building CLI applications, omitting dependencies like `rich` and `shellingham`. However, since version 0.22.0, `typer-slim` merely installs the full `typer` package, rendering its 'slim' purpose obsolete. As of version 0.24.1, `typer-slim` has been officially abandoned, with no further updates or releases planned. Users are strongly advised to install `typer` directly instead.

Warnings

breaking `typer-slim` is officially abandoned. No further versions or updates will be released. Users should migrate all dependencies to the main `typer` package.
Fix: Uninstall `typer-slim` and install `typer` directly: `pip uninstall typer-slim && pip install typer`.
breaking Since version 0.22.0, `typer-slim` became a direct wrapper around the full `typer` package, negating its original purpose of being 'slim' by implicitly installing `rich` and `shellingham`.
Fix: If you wanted a 'slim' version without `rich` and `shellingham`, this package no longer provides that. Migrate to `typer` and consider disabling Rich globally with `TYPER_USE_RICH=0` if desired.
gotcha Installing both `typer` and `typer-slim` in the same environment can lead to package conflicts, file overwrites, and corrupted installations, making one or both packages unusable.
Fix: Always install only `typer` or `typer-slim`, never both. Given the abandonment of `typer-slim`, stick to `typer`.
breaking Support for Python 3.9 was dropped in version 0.24.0, and Python 3.8 was dropped in version 0.21.0.
Fix: Ensure your project uses Python 3.10 or newer. For older Python versions, you must pin to an earlier `typer-slim` release (e.g., `<0.21.0` for Python 3.8, or `<0.24.0` for Python 3.9).
gotcha Starting with version 0.23.0, the default behavior for Rich tracebacks changed to not show local variables, which can make debugging more difficult in some cases.
Fix: To re-enable locals in Rich tracebacks, you might need to configure Rich or Typer explicitly, or set the environment variable `TYPER_STANDARD_TRACEBACK=1` for standard Python tracebacks.

Install

pip install typer-slim Install Typer-Slim (Not Recommended)
pip install typer Install Typer (Recommended Alternative)

Imports

Typer
```
from typer import Typer
```

Quickstart

This quickstart demonstrates a basic Typer CLI application. To run, save as `main.py` and execute `python main.py hello --name Alice` or `python main.py hello`. While this works with `typer-slim`, directly installing and using `typer` is recommended.

import typer

app = typer.Typer()

@app.command()
def hello(name: str = 'World'):
    """Say hello to NAME."""
    typer.echo(f"Hello {name}!")

if __name__ == '__main__':
    app()

view raw JSON →