bbox-overlay
Minimal Python overlay to draw bounding boxes on top of the screen (Linux/X11).
Highlights
- Lightweight X11 overlay using thin border windows.
- Optional labels and color control.
- Simple CLI with JSON input.
Requirements
- Linux/X11 (or WSLg/XWayland on Windows 11).
- Tkinter (e.g.
sudo apt-get install python3-tkon Ubuntu).
Install
PyPI
python3 -m pip install bbox-overlay
Editable (dev)
python3 -m pip install -e .[dev]
Usage
bbox-overlay --boxes '[{"x":100,"y":100,"w":200,"h":150,"label":"cat"}]'
- Close with
Esc,Ctrl+C, or any key in the console (when--timeoutis omitted). - Coordinates are pixel-based, origin at top-left.
- The overlay uses thin border windows per box to avoid fullscreen opacity on X11.
- Labels are optional and use the
labelfield in each box object. - Colors accept Tk names (
red,cyan) or hex (#RRGGBB).
Development
ruff check .
ruff format .
mypy bbox_overlay
pytest
Project links
- Source: https://github.com/albertoburgosplaza/bbox-overlay
- Issues: https://github.com/albertoburgosplaza/bbox-overlay/issues
- Changelog: https://github.com/albertoburgosplaza/bbox-overlay/blob/main/CHANGELOG.md
CLI options
bbox-overlay --help
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bbox_overlay-0.1.3.tar.gz
(7.6 kB
view details)
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 bbox_overlay-0.1.3.tar.gz.
File metadata
- Download URL: bbox_overlay-0.1.3.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39ce27815e12c2f564a4e12c018d15ffee09727d487e63c1fa8fcbbd335e1acf
|
|
| MD5 |
8090cf91ce5c2277c397e4e43e6b759d
|
|
| BLAKE2b-256 |
8c6a7bd081c6aacdc7ee1e78ec98dd98d19814902458487e62fd001307d818ad
|
Provenance
The following attestation bundles were made for bbox_overlay-0.1.3.tar.gz:
Publisher:
release.yml on albertoburgosplaza/bbox-overlay
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bbox_overlay-0.1.3.tar.gz -
Subject digest:
39ce27815e12c2f564a4e12c018d15ffee09727d487e63c1fa8fcbbd335e1acf - Sigstore transparency entry: 774303203
- Sigstore integration time:
-
Permalink:
albertoburgosplaza/bbox-overlay@3e0f388a35f92d913fa47ee879fedf4fcfe9cd33 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/albertoburgosplaza
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3e0f388a35f92d913fa47ee879fedf4fcfe9cd33 -
Trigger Event:
push
-
Statement type:
File details
Details for the file bbox_overlay-0.1.3-py3-none-any.whl.
File metadata
- Download URL: bbox_overlay-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.0 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 |
388986ced6d748a0ac03eb50e3f38e9fb43c111ccfd319e9a07a08160d8ced7a
|
|
| MD5 |
426bec0a4d0cb1c26a40281b08c59dfc
|
|
| BLAKE2b-256 |
e649d52523bd426f402363aaed607462bf93f4ad8b90f30080c022bf4ebc302a
|
Provenance
The following attestation bundles were made for bbox_overlay-0.1.3-py3-none-any.whl:
Publisher:
release.yml on albertoburgosplaza/bbox-overlay
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bbox_overlay-0.1.3-py3-none-any.whl -
Subject digest:
388986ced6d748a0ac03eb50e3f38e9fb43c111ccfd319e9a07a08160d8ced7a - Sigstore transparency entry: 774303205
- Sigstore integration time:
-
Permalink:
albertoburgosplaza/bbox-overlay@3e0f388a35f92d913fa47ee879fedf4fcfe9cd33 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/albertoburgosplaza
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3e0f388a35f92d913fa47ee879fedf4fcfe9cd33 -
Trigger Event:
push
-
Statement type:
