Skip to content
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

feat: UIs as CLI commands #32

Merged
merged 1 commit into from
Jun 15, 2024
+238 −229
Merged

feat: UIs as CLI commands #32

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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down Expand Up @@ -113,5 +112,4 @@ omit = [
"sksmithy/_logger.py",
"sksmithy/_prompts.py",
"sksmithy/tui/__init__.py",
"sksmithy/tui/__main__.py",
]
Loading