Skip to content

docs(release): use uv in install instructions #66

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

Merged
tulayha merged 2 commits into from
Aug 3, 2026
+15 −1
Merged

docs(release): use uv in install instructions #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df7050c
docs(release): use uv in install instructions
tulayha Aug 3, 2026
135cbf7
Merge branch 'main' into fix/release-install-command
tulayha Aug 3, 2026
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
11 changes: 10 additions & 1 deletion .github/release-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ Verify downloaded files against [SHA256SUMS]({checksums_url}).
### Command line

```bash
python -m pip install "vidxp[local-worker,mcp]=={version}"
uv tool install --python 3.14 --torch-backend cpu \
"vidxp[local-worker,mcp]=={version}"
```

Install [uv](https://docs.astral.sh/uv/getting-started/installation/) first. Add
`frontend` to the extras if you also want the local browser interface:

```bash
uv tool install --python 3.14 --torch-backend cpu \
"vidxp[local-worker,mcp,frontend]=={version}"
```

### Containers
Expand Down
5 changes: 5 additions & 0 deletions tests/test_release_notes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,12 @@ def test_release_page_links_exact_assets_before_changelog(self):

self.assertLess(result.index("## Download VidXP"), result.index("## Changelog"))
self.assertIn("VidXP%20Setup.exe", result)
self.assertIn(
"uv tool install --python 3.14 --torch-backend cpu", result
)
self.assertIn("vidxp[local-worker,mcp]==0.4.0-b", result)
self.assertIn("vidxp[local-worker,mcp,frontend]==0.4.0-b", result)
self.assertNotIn("python -m pip install", result)
self.assertIn("ghcr.io/grayhatdevelopers/vidxp:0.4.0-b", result)
self.assertNotIn("Beta release", result)

Expand Down