feat: UIs as CLI commands

FBruzzesi · Jun 15, 2024 · 97438e8 · 97438e8
1 parent 3411065
commit 97438e8
Show file tree

Hide file tree

Showing 8 changed files with 238 additions and 229 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ How can you use it?
 
 <details><summary>✅ As a TUI (terminal user interface) in the terminal.</summary>
 
-- Available via the `smith-tui` command.
+- Available via the `smith forge-tui` command.
 - It requires installing [extra dependencies](#extra-dependencies): `python -m pip install "sklearn-smithy[textual]"`
 - Powered by [textual](https://textual.textualize.io/).
 

diff --git a/docs/contribute.md b/docs/contribute.md
@@ -50,7 +50,7 @@ Let's suppose that you already did steps 1-4 from the above list, now you should
 
 ```bash
 cd sklearn-smithy
-pip install -e ".[streamlit]" --no-cache-dir
+pip install -e ".[all]" --no-cache-dir
 pre-commit install
 ```
 

diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ How can you use it?
 
 - [x] Directly from the browser via our [web UI](https://sklearn-smithy.streamlit.app/){:target="_blank"} ([more info](user-guide.md/#web-ui))
 - [x] As a CLI (command line interface) in your terminal via the `smith forge` command ([more info](user-guide.md/#cli))
-- [x] As a TUI (terminal user interface) in your terminal via the `smith-tui` command ([more info](user-guide.md/#tui))
+- [x] As a TUI (terminal user interface) in your terminal via the `smith forge-tui` command ([more info](user-guide.md/#tui))
 
 !!! info
 

diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -78,14 +78,14 @@ from sklearn.utils.validation import check_is_fitted, check_array
 
 TL;DR:
 
-- [x] Available via the `smith-tui` command.
+- [x] Available via the `smith forge-tui` command.
 - [x] It requires installing [extra dependencies](installation.md#extra-dependencies): `python -m pip install "sklearn-smithy[textual]"`
 - [x] Powered by [textual](https://textual.textualize.io/){:target="_blank"}.
 
-If you like the CLI, but prefer a more interactive and graphical way from the comfort of your terminal, you can use the TUI (Terminal User Interface) provided by the `smith-tui` command.
+If you like the CLI, but prefer a more interactive and graphical way from the comfort of your terminal, you can use the TUI (Terminal User Interface) provided by the `smith forge-tui` command.
 
 ```console
-$ smith-tui
+$ smith forge-tui
 ```
 
 ```{.textual path="sksmithy/tui/_tui.py" columns="200" lines="35"}

diff --git a/pyproject.toml b/pyproject.toml
@@ -62,7 +62,6 @@ all = [
 
 [project.scripts]
 smith = "sksmithy.__main__:cli"
-smith-tui = "sksmithy.tui.__main__:forge_tui"
 
 [tool.hatch.build.targets.sdist]
 only-include = ["sksmithy"]
@@ -113,5 +112,4 @@ omit = [
     "sksmithy/_logger.py",
     "sksmithy/_prompts.py",
     "sksmithy/tui/__init__.py",
-    "sksmithy/tui/__main__.py",
 ]