|
| 1 | +# machinevision-toolbox-python — Agent Instructions |
| 2 | + |
| 3 | +Part of the RVC ecosystem. **Read [rvc-ecosystem/AGENTS.md](https://github.com/petercorke/rvc-ecosystem/blob/main/AGENTS.md) first** — it defines shared conventions: repo ownership, math invariants, dependency boundaries, git/PR workflow, code standards, tech-debt tracking. This file only adds what's specific to this repo. |
| 4 | + |
| 5 | +| | | |
| 6 | +|---|---| |
| 7 | +| PyPI package | `machinevision-toolbox-python` | |
| 8 | +| Nickname | MVTB | |
| 9 | +| Owner | Peter Corke (`petercorke`) | |
| 10 | +| Default branch | `main` | |
| 11 | +| Contribution model | Branch → PR; direct push to `main` at Peter's discretion | |
| 12 | + |
| 13 | +## Notes specific to this repo |
| 14 | + |
| 15 | +- Pure Python — no compiled extensions, builds with Hatch (`hatchling`) directly. |
| 16 | +- Depends on `spatialmath`, `pgraph-python`, `ansitable`, plus the third-party `opencv-python`/ |
| 17 | + `opencv-contrib-python` and `open3d`. |
| 18 | +- `open3d` is consistently a Python version or two behind — never assume it supports the |
| 19 | + latest Python release; check compatibility before bumping this repo's Python floor/ceiling. |
| 20 | +- OpenCV 5.x support was just added alongside the existing 4.x support (a major version jump, |
| 21 | + not a minor bump). This is fresh work — aim to keep both working, but treat 4.x/5.x |
| 22 | + compatibility friction as expected teething problems to fix, not a regression. |
| 23 | +- Tech-debt tracked as GitHub Issues labelled `tech-debt` (migrated 2026-08-02) — this repo |
| 24 | + was first to migrate off `tech-debt.md`. |
| 25 | +- This repo's `.github/pull_request_template.md` and `.github/ISSUE_TEMPLATE/*.yml` are the |
| 26 | + canonical source other repos' templates were copied from — check here first if updating |
| 27 | + template content ecosystem-wide. |
| 28 | +- Codacy is wired in (badge + automated PR comments); grade A is the aspiration. Real backlog |
| 29 | + exists, tracked via `tech-debt`-labelled issues (including a "mypy not in CI" entry) — see |
| 30 | + ecosystem `AGENTS.md` §5 for how that target is framed. |
0 commit comments