Duckboot/cv4pve-cli-tui
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document installing cv4pve-tui as a uv tool #28

Merged
Duckboot merged 1 commits from docs/install-as-tool-17 into main 2026-11-03 01:32:52 +01:00
Conversation 0 Commits 1 Files Changed 1
+17
Duckboot commented 2026-11-03 00:31:13 +01:00
Owner
Copy link
Copy source

What

  • Install section: the README gets an "Install" section covering uv tool install from the Gitea repo or from a local checkout, then upgrade and uninstall.
  • Run section: it now says to use cv4pve-tui when installed, and uv run cv4pve-tui from a checkout.
  • Packaging: no changes were needed. The pyproject.toml metadata (entry point, readme, requires-python) already works for uv tool install.

Verification

All of this used throwaway tool dirs (UV_TOOL_DIR and UV_TOOL_BIN_DIR under /tmp), so the user's own tools were not touched.

  • uv tool install . gave a cv4pve-tui binary.
  • That binary, started from /tmp in a pseudo-terminal, drew the guest frame and ran until it was stopped.
  • uv tool install git+https://git.duckboot.net/Duckboot/cv4pve-cli-tui@docs/install-as-tool-17 installed the binary straight from the repo.

This PR is stacked on #27.

Closes #17

Co-Authored-By: Claude Opus 5.5 noreply@anthropic.com

## What - **Install section:** the README gets an "Install" section covering `uv tool install` from the Gitea repo or from a local checkout, then upgrade and uninstall. - **Run section:** it now says to use `cv4pve-tui` when installed, and `uv run cv4pve-tui` from a checkout. - **Packaging:** no changes were needed. The `pyproject.toml` metadata (entry point, readme, requires-python) already works for `uv tool install`. ## Verification All of this used throwaway tool dirs (`UV_TOOL_DIR` and `UV_TOOL_BIN_DIR` under `/tmp`), so the user's own tools were not touched. - `uv tool install .` gave a `cv4pve-tui` binary. - That binary, started from `/tmp` in a pseudo-terminal, drew the guest frame and ran until it was stopped. - `uv tool install git+https://git.duckboot.net/Duckboot/cv4pve-cli-tui@docs/install-as-tool-17` installed the binary straight from the repo. This PR is stacked on #27. Closes #17 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Duckboot added 2 commits 2026-11-03 00:31:13 +01:00
Warn on an untested cv4pve-cli version at startup
CI / pytest and ruff (pull_request) Successful in 4m42s
Details
CI / pytest and ruff (push) Has been cancelled
Details
e7569a7bf7 
At startup the app runs `cv4pve-cli --version`. If it differs from
cli.TESTED_VERSION (2.4.0), a warning says which version was found
and which one was tested. The app parses output formats that are not
a stable API: the config list text, prune-backups as a JSON string,
the CT ip-addresses JSON string and the exit codes with --wait. A
newer cv4pve-cli could break them in confusing ways.

If cv4pve-cli cannot be run at all, an error says so once, instead of
every later call failing without explanation. The README notes the
tested version.

Closes #14

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Document installing cv4pve-tui as a uv tool
CI / pytest and ruff (pull_request) Successful in 4m40s
Details
CI / pytest and ruff (push) Has been cancelled
Details
ff6345c80f 
The README gets an "Install" section: install with uv tool from the
Gitea repo or from a local checkout, then upgrade and uninstall. The
"Run" section says to use `cv4pve-tui` when installed and
`uv run cv4pve-tui` from a checkout.

Verified by installing into throwaway tool dirs (UV_TOOL_DIR and
UV_TOOL_BIN_DIR under /tmp): `uv tool install .` gave a cv4pve-tui
binary. Started from /tmp in a pseudo-terminal, it drew the guest
frame and ran until it was stopped. The pyproject metadata (entry
point, readme, requires-python) was already enough.

Closes #17

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Duckboot merged commit ff6345c80f into main 2026-11-03 01:32:52 +01:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
priority
1-high
Do first: biggest safety or maintenance gain
priority
2-medium
Next: clear everyday value
priority
3-low
Useful, but less often needed
priority
4-nice-to-have
Small conveniences; do when convenient
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
Duckboot (Per-Arne Hellarvik)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Duckboot/cv4pve-cli-tui#28