Skip to main content

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

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tux_review-0.1.0.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tux_review-0.1.0-py3-none-any.whl (67.7 kB view details)

Uploaded Python 3

File details

Details for the file tux_review-0.1.0.tar.gz.

File metadata

  • Download URL: tux_review-0.1.0.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for tux_review-0.1.0.tar.gz
Algorithm Hash digest
SHA256 587418b76aadb2db9c447dc8ab28f6cfd02349d124573f6e2087424d0ce8317d
MD5 b4187cf15d56fb8a45731dc35b2a1929
BLAKE2b-256 ba91b4dd0e9c00b8610d48f96e756998a9dfd722c749e1cdcfb92520ec22ef53

See more details on using hashes here.

Provenance

The following attestation bundles were made for tux_review-0.1.0.tar.gz:

Publisher: publish.yml on sommelo1/tux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tux_review-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tux_review-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 67.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for tux_review-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0009a99b50470739efb1ec5b98360e342486db333fd6e1a4ba2bd9a85631bc6a
MD5 96d206f49a0a4a19aa0e610339172aca
BLAKE2b-256 575f52f13dc3b8b546cad47f13fec81f4132f44b30e0735ec0859aef711830d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for tux_review-0.1.0-py3-none-any.whl:

Publisher: publish.yml on sommelo1/tux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page