feat: Add support for Typer

Textualize · May 22, 2023 · 7430cb1 · 7430cb1
1 parent b9ddd90
commit 7430cb1
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -90,6 +90,7 @@ pip install trogon
 
 ## Quickstart
 
+### Click
 1. Import `from trogon import tui`
 2. Add the `@tui` decorator above your click app. e.g.
     ```python
@@ -100,6 +101,15 @@ pip install trogon
     ```
 3. Your click app will have a new `tui` command available.
 
+### Typer
+1. Import `from trogon import tui`
+2. Add the `tui` decorator above your typer app. e.g.
+    ```python
+    cli = Typer(...)
+    cli = tui()(cli)
+    ```
+3. Your click app will have a new `tui` command available.
+
 See also the `examples` folder for two example apps.
 
 ## Follow this project

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,9 @@ textual = {version = ">=0.26.0"}
 #textual = {extras = ["dev"], path = "../textual", develop = true}
 click = ">=8.0.0"
 
+[tool.poetry.extras]
+typer = ["typer=^0.9.0"]
+
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.2.0"

diff --git a/trogon/_.py b/trogon/_.py