Merge branch 'master' into feat/pydantic

Author: svlandeg

README.md

@@ -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
@@ -78,29 +81,29 @@ Run your application with the `typer` command:
 // Run your application
 $ typer main.py run
 
-// You get a nice error, you are missing NAME
-Usage: typer [PATH_OR_MODULE] run [OPTIONS] NAME
+// You get a nice error, you are missing 'name'
+Usage: typer [PATH_OR_MODULE] run [OPTIONS] {name}
 Try 'typer [PATH_OR_MODULE] run --help' for help.
 ╭─ Error ───────────────────────────────────────────╮
-│ Missing argument 'NAME'.                          │
+│ Missing argument 'name'.                          │
 ╰───────────────────────────────────────────────────╯
 
 
 // You get a --help for free
 $ typer main.py run --help
 
-Usage: typer [PATH_OR_MODULE] run [OPTIONS] NAME
+Usage: typer [PATH_OR_MODULE] run [OPTIONS] {name}
 
 Run the provided Typer app.
 
 ╭─ Arguments ───────────────────────────────────────╮
-│ *    name      TEXT  [default: None] [required]   |
+│ *    name      <str>  [required]                  │
 ╰───────────────────────────────────────────────────╯
 ╭─ Options ─────────────────────────────────────────╮
 │ --help          Show this message and exit.       │
 ╰───────────────────────────────────────────────────╯
 
-// Now pass the NAME argument
+// Now pass the 'name' argument
 $ typer main.py run Camila
 
 Hello Camila
@@ -136,30 +139,30 @@ 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
+// You get a nice error, you are missing 'name'
+Usage: main.py [OPTIONS] {name}
 Try 'main.py --help' for help.
 ╭─ Error ───────────────────────────────────────────╮
-│ Missing argument 'NAME'.                          │
+│ Missing argument 'name'.                          │
 ╰───────────────────────────────────────────────────╯
 
 
 // You get a --help for free
-$ python main.py --help
+$ uv run python main.py --help
 
-Usage: main.py [OPTIONS] NAME
+Usage: main.py [OPTIONS] {name}
 
 ╭─ Arguments ───────────────────────────────────────╮
-│ *    name      TEXT  [default: None] [required]   |
+│ *    name      <str>  [required]                  │
 ╰───────────────────────────────────────────────────╯
 ╭─ Options ─────────────────────────────────────────╮
 │ --help          Show this message and exit.       │
 ╰───────────────────────────────────────────────────╯
 
-// Now pass the NAME argument
-$ python main.py Camila
+// Now pass the 'name' argument
+$ uv run python main.py Camila
 
 Hello Camila
 
@@ -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]...
 
@@ -236,13 +239,13 @@ $ python main.py --help
 │                               and exit.           │
 ╰───────────────────────────────────────────────────╯
 ╭─ Commands ────────────────────────────────────────╮
-│ goodbye                                           │
 │ hello                                             │
+│ goodbye                                           │
 ╰───────────────────────────────────────────────────╯
 
 // When you create a package you get ✨ auto-completion ✨ for free, installed with --install-completion
 
-// You have 2 subcommands (the 2 functions): goodbye and hello
+// You have 2 subcommands (the 2 functions): hello and goodbye
 ```
 
 </div>
@@ -252,12 +255,12 @@ 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
+ Usage: main.py hello [OPTIONS] {name}
 
 ╭─ Arguments ───────────────────────────────────────╮
-│ *    name      TEXT  [default: None] [required]   │
+│ *    name      <str>  [required]                  │
 ╰───────────────────────────────────────────────────╯
 ╭─ Options ─────────────────────────────────────────╮
 │ --help          Show this message and exit.       │
@@ -271,12 +274,12 @@ 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
+ Usage: main.py goodbye [OPTIONS] {name}
 
 ╭─ Arguments ───────────────────────────────────────╮
-│ *    name      TEXT  [default: None] [required]   │
+│ *    name      <str>  [required]                  │
 ╰───────────────────────────────────────────────────╯
 ╭─ Options ─────────────────────────────────────────╮
 │ --formal    --no-formal      [default: no-formal] │
@@ -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.
 ```