Skip to content

📝 Recommend uv projects by default in docs #1903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 1 commit into from
Jul 21, 2026
Merged

📝 Recommend uv projects by default in docs #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,21 @@ The key features are:

## Installation

Create and activate a [virtual environment](https://typer.tiangolo.com/virtual-environments/) and then install **Typer**:
First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add **Typer** to your project:

<div class="termy">

```console
$ pip install typer
$ uv add typer
---> 100%
Successfully installed typer rich shellingham
```

</div>

This installs both the Typer library and the `typer` command in the project's virtual environment. To use `typer` directly with shell completion, [activate the project environment and install completion](tutorial/install.md#activate-the-virtual-environment).

If you prefer to use `pip`, install `typer` inside a virtual environment. See the [installation guide](tutorial/install.md) for the alternative steps.

## Example

### The absolute minimum
Expand Down Expand Up @@ -136,7 +139,7 @@ Now you could run it with Python directly:

```console
// Run your application
$ python main.py
$ uv run python main.py

// You get a nice error, you are missing 'name'
Usage: main.py [OPTIONS] {name}
Expand All @@ -147,7 +150,7 @@ Try 'main.py --help' for help.


// You get a --help for free
$ python main.py --help
$ uv run python main.py --help

Usage: main.py [OPTIONS] {name}

Expand All @@ -159,7 +162,7 @@ Usage: main.py [OPTIONS] {name}
╰───────────────────────────────────────────────────╯

// Now pass the 'name' argument
$ python main.py Camila
$ uv run python main.py Camila

Hello Camila

Expand Down Expand Up @@ -219,7 +222,7 @@ Check the new help:
<div class="termy">

```console
$ python main.py --help
$ uv run python main.py --help

Usage: main.py [OPTIONS] COMMAND [ARGS]...

Expand Down Expand Up @@ -252,7 +255,7 @@ Now check the help for the `hello` command:
<div class="termy">

```console
$ python main.py hello --help
$ uv run python main.py hello --help

Usage: main.py hello [OPTIONS] {name}

Expand All @@ -271,7 +274,7 @@ And now check the help for the `goodbye` command:
<div class="termy">

```console
$ python main.py goodbye --help
$ uv run python main.py goodbye --help

Usage: main.py goodbye [OPTIONS] {name}

Expand All @@ -296,19 +299,19 @@ Now you can try out the new command line application:
```console
// Use it with the hello command

$ python main.py hello Camila
$ uv run python main.py hello Camila

Hello Camila

// And with the goodbye command

$ python main.py goodbye Camila
$ uv run python main.py goodbye Camila

Bye Camila!

// And with --formal

$ python main.py goodbye --formal Camila
$ uv run python main.py goodbye --formal Camila

Goodbye Ms. Camila. Have a good day.
```
Expand Down
Loading