TUX Review
TUX turns a running web UI into a review artifact. Reviewers attach structured, machine-readable feedback to pages, routes, components, element instances, and UI states directly in the browser.
This is the Python/PyPI variant of the TUX CLI and local review server. It is stdlib-only and requires Python 3.10 or newer.
Choose it when you want an isolated Python command-line tool or server
without Node.js. If your project uses npm/JavaScript or needs the
tux-review/client export, install the Node.js package instead. Do not
install both variants for one project: their tux commands and output are
the same.
Install
For a globally isolated command-line tool, use pipx:
pipx install tux-review
tux --version
Or install into your active virtual environment:
python -m pip install tux-review
tux --version
Typical workflow
After installation, all commands use tux …. For a clickable design:
tux design install --framework vanilla
tux design create --framework vanilla --name checkout
tux design start-review
For an existing application, use the live-review workflow:
tux live install
tux live start-review --url http://localhost:3000
Feedback is stored in .tux/feedback.json by default and can be inspected or
exported with tux feedback show and tux feedback export.
What is included
- A deterministic CLI for design and live UI reviews
- A local review/design server and embedded plain-JavaScript Review Client
- Vanilla, React, Vue, and Angular design templates
- Canonical JSON feedback and agent skills
Documentation and support
The complete guide, examples, and normative specification are in the GitHub repository. Report issues at github.com/sommelo1/tux/issues.
License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tux_review-0.1.1.tar.gz.
File metadata
- Download URL: tux_review-0.1.1.tar.gz
- Upload date:
- Size: 52.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8f9268ace50aae8b118516c0e2ac8d9f6cec21dc9ea9b461095fe925a686214
|
|
| MD5 |
bb4bc0a378f0fb8d36c22219be961615
|
|
| BLAKE2b-256 |
ed5e7568af78a1e629f1680c22a295200b59a9c6394bd1fdd1756fab09eef009
|
Provenance
The following attestation bundles were made for tux_review-0.1.1.tar.gz:
Publisher:
publish.yml on sommelo1/tux
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tux_review-0.1.1.tar.gz -
Subject digest:
c8f9268ace50aae8b118516c0e2ac8d9f6cec21dc9ea9b461095fe925a686214 - Sigstore transparency entry: 2645779350
- Sigstore integration time:
-
Permalink:
sommelo1/tux@cf708c2b77f090dbd3b6f6f19949cb1f66c6d2bb -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/sommelo1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@cf708c2b77f090dbd3b6f6f19949cb1f66c6d2bb -
Trigger Event:
push
-
Statement type:
File details
Details for the file tux_review-0.1.1-py3-none-any.whl.
File metadata
- Download URL: tux_review-0.1.1-py3-none-any.whl
- Upload date:
- Size: 68.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec403fe252d42410c51257f668aca366202b8507c10df8f5d99f810f0aa94ce4
|
|
| MD5 |
9898417c2b34fffa6138161fbea8e2b9
|
|
| BLAKE2b-256 |
257b8016937ca9d0ac1727f94f97950a9384b5f63ef4902e1e0408a035a27684
|
Provenance
The following attestation bundles were made for tux_review-0.1.1-py3-none-any.whl:
Publisher:
publish.yml on sommelo1/tux
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tux_review-0.1.1-py3-none-any.whl -
Subject digest:
ec403fe252d42410c51257f668aca366202b8507c10df8f5d99f810f0aa94ce4 - Sigstore transparency entry: 2645779361
- Sigstore integration time:
-
Permalink:
sommelo1/tux@cf708c2b77f090dbd3b6f6f19949cb1f66c6d2bb -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/sommelo1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@cf708c2b77f090dbd3b6f6f19949cb1f66c6d2bb -
Trigger Event:
push
-
Statement type: