UX/UI audit tool with screenshots and Gemini analysis
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
uxaudit
UX/UI audit tool that captures screenshots and analyzes them with Gemini.
Highlights
- Full-page and section screenshots with evidence links.
- Multi-page crawling from header, nav, and footer.
- Structured JSON output for agents and pipelines.
Requirements
- Python 3.10+
- Playwright browsers:
playwright install - Gemini API key:
GEMINI_API_KEY(orGOOGLE_API_KEY)
Install
PyPI
python3 -m pip install uxaudit
Editable (dev)
python3 -m pip install -e .[dev]
Usage
export GEMINI_API_KEY="your-key"
uxaudit analyze https://example.com --model flash
Outputs are written to runs/<run_id>/ with manifest.json and report.json.
Crawling multiple pages
uxaudit analyze https://example.com --max-pages 5
Development
ruff check .
ruff format .
mypy uxaudit
pytest
Project links
- Source: https://github.com/albertoburgosplaza/uxaudit
- Issues: https://github.com/albertoburgosplaza/uxaudit/issues
- Changelog: https://github.com/albertoburgosplaza/uxaudit/blob/main/CHANGELOG.md
CLI options
uxaudit analyze --help
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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 uxaudit-0.1.0.tar.gz.
File metadata
- Download URL: uxaudit-0.1.0.tar.gz
- Upload date:
- Size: 13.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0db3961b2529c4d0951f1e9101f6b52cf054fabe4aee58cb9c49fef96bed9f50
|
|
| MD5 |
8db5c8344b1dec12bf6e4cf0eb137fc5
|
|
| BLAKE2b-256 |
8559ef6ad572f55195fa5d85d682122a9a59b4181f8c2e7ce3fba80e10d0195b
|
Provenance
The following attestation bundles were made for uxaudit-0.1.0.tar.gz:
Publisher:
release.yml on albertoburgosplaza/uxaudit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
uxaudit-0.1.0.tar.gz -
Subject digest:
0db3961b2529c4d0951f1e9101f6b52cf054fabe4aee58cb9c49fef96bed9f50 - Sigstore transparency entry: 779101131
- Sigstore integration time:
-
Permalink:
albertoburgosplaza/uxaudit@f299bad4b318f6e7e8a8e5cc65f31364377db447 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/albertoburgosplaza
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f299bad4b318f6e7e8a8e5cc65f31364377db447 -
Trigger Event:
push
-
Statement type:
File details
Details for the file uxaudit-0.1.0-py3-none-any.whl.
File metadata
- Download URL: uxaudit-0.1.0-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
64f588efa2a4433ec052341889ee7f78aad8c2a0886917d144ec27a50a817933
|
|
| MD5 |
aa5b779e304669c14e35f9f6190c9213
|
|
| BLAKE2b-256 |
78cefd959ca6be8d85494f9f2f7fdf3c624254c976acf550282ff6927a46dcb9
|
Provenance
The following attestation bundles were made for uxaudit-0.1.0-py3-none-any.whl:
Publisher:
release.yml on albertoburgosplaza/uxaudit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
uxaudit-0.1.0-py3-none-any.whl -
Subject digest:
64f588efa2a4433ec052341889ee7f78aad8c2a0886917d144ec27a50a817933 - Sigstore transparency entry: 779101137
- Sigstore integration time:
-
Permalink:
albertoburgosplaza/uxaudit@f299bad4b318f6e7e8a8e5cc65f31364377db447 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/albertoburgosplaza
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f299bad4b318f6e7e8a8e5cc65f31364377db447 -
Trigger Event:
push
-
Statement type:
