|
1 | 1 | .. include:: ./refs.rst |
2 | 2 | .. role:: big |
3 | | -.. role:: extrabig |
4 | | - |
5 | | -.. we use big role instead of index because a TOC on this page screws up the latex page generation |
6 | | -
|
7 | | -:extrabig:`Django Typer` |
8 | 3 |
|
| 4 | +============ |
| 5 | +Django Typer |
| 6 | +============ |
9 | 7 |
|
10 | 8 | Use Typer_ to define the CLI for your Django_ management commands. Provides a TyperCommand class |
11 | 9 | that inherits from BaseCommand_ and allows typer-style annotated parameter types. All of the |
12 | 10 | BaseCommand functionality is preserved, so that TyperCommand can be a drop in replacement. |
13 | 11 |
|
14 | 12 | **django-typer makes it easy to:** |
15 | 13 |
|
16 | | - * Define your command CLI interface in a clear, DRY and safe way using type hints |
17 | | - * Create subcommand and group command hierarchies. |
18 | | - * Use the full power of Typer's parameter types to validate and parse command line inputs. |
19 | | - * Create beautiful and information dense help outputs. |
20 | | - * Configure the rendering of exception stack traces using rich. |
21 | | - * :ref:`Install shell tab-completion support <shellcompletions>` for TyperCommands and normal |
22 | | - Django_ commands for bash_, zsh_, fish_ and powershell_. |
23 | | - * :ref:`Create custom and portable shell tab-completions for your CLI parameters. |
24 | | - <define-shellcompletions>` |
25 | | - * Refactor existing management commands into TyperCommands because TyperCommand is interface |
26 | | - compatible with BaseCommand. |
| 14 | + * Define your command CLI interface in a clear, DRY and safe way using type hints |
| 15 | + * Create subcommand and group command hierarchies. |
| 16 | + * Use the full power of Typer's parameter types to validate and parse command line inputs. |
| 17 | + * Create beautiful and information dense help outputs. |
| 18 | + * Configure the rendering of exception stack traces using rich. |
| 19 | + * :ref:`Install shell tab-completion support <shellcompletions>` for TyperCommands and normal |
| 20 | + Django_ commands for bash_, zsh_, fish_ and powershell_. |
| 21 | + * :ref:`Create custom and portable shell tab-completions for your CLI parameters. |
| 22 | + <define-shellcompletions>` |
| 23 | + * Refactor existing management commands into TyperCommands because TyperCommand is interface |
| 24 | + compatible with BaseCommand. |
| 25 | + |
27 | 26 |
|
28 | 27 | :big:`Installation` |
29 | 28 |
|
|
0 commit comments