da654944dc
End-of-pipeline cleanup. No structural changes; documents what is done, what is left, and the discipline for future cleanup commits. Skill: - simplifying-python: end-of-session cleanup discipline. Inspired by Anthropic's open-sourced code-simplifier. Targets duplication, dead code, voodoo constants, stale comments, misnamed identifiers, unnecessary abstraction. Anti-targets: architecture, public API surface, schema, sweeping rewrites. Behavior preservation enforced by running pytest before and after. Simplify pass on shopdb/utils/responses.py: - error_response docstring claimed the error info lives at top level `error`. Implementation puts it under `data.error` (consistent with the success envelope). Implementation is correct; docstring updated. - paginated_response docstring used snake_case keys (`per_page`, `total_pages`, etc). Implementation uses lowercase concatenated per CONTRIBUTING.md. Docstring updated to match. Documentation: - docs/PLUGINS.md: bundled plugins (six, with what they track and caveats per ADR), planned plugins (measuringtools as the scaffold canary per ADR-005), distribution conventions for sister-site plugins per ADR-003, naming policy. - docs/ROADMAP.md: phase status table (0-5 done, 6 in progress), must-have work for 1.0 (Asset.mapx/mapy, equipment migration, printers retirement, frontend hook contract, per-plugin Alembic chains), nice-to-have (measuringtools plugin, frontend scaffolding, marketplace listing, surface-diff tooling), deferred (multi-tenancy, pip-installable plugins, event bus). Defines what 1.0.0 means as a contract. Test count unchanged: 101 passing. Naming/style check green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4.6 KiB
4.6 KiB
Roadmap
shopdb-flask is at __contract_version__ = '0.2.0' (pre-1.0). This document captures what stands between today and a stable 1.0.0 release. Maintained as scope evolves; supersedes nothing in the ADRs.
Phase status
| Phase | Status | Commit |
|---|---|---|
| 0 - Lock platform contract, naming, style enforcement | DONE | d6725c0 |
| 1 - pytest baseline, production hardening, pinned requirements | DONE | 2d1bb83 |
| 2 - Plugin contract surface and compliance tests | DONE | 5fefb53 |
| 3 - Manifest-first loader, shopdb.api namespace, auto-register blueprints | DONE | 6f085a1 |
4 - Plugin scaffolding (flask plugin new) |
DONE | 8eb9362 |
| 5 - Alembic baseline, per-site deploy, ADRs to docs/adr | DONE | d4e3ac9 |
| 6 - Polish (this phase) | IN PROGRESS | this commit |
What's left before tagging 1.0.0
Must-have
- Asset model fully wired.
Asset.mapx, Asset.mapycolumns,AssetRelationship.inheritsposition,AssetRelationship.propagatesthroughidcolumns. Models match the locked ADR-001 surface thatresolve_asset_positionalready targets. - Equipment data migration script for facilities migrating from legacy ASP shopdb. One-shot script under
scripts/migration/. See migrating-asset-schema for the policy. Per ADR-001, onlycategory='Equipment' AND machinenumber IS NOT NULLmigrates. - Printers retirement. Legacy
PrinterDatamodel,printers_bplegacy blueprint, and the frontendPrinterForm.vuereferences toprinter.printerdata.*get removed in lockstep. Coordinated with the equipment migration. - Frontend hook contract. Vue side equivalents for the backend hook system: how plugins expose asset-detail components, map markers, search-result renderers. Requires its own design ADR.
- Per-plugin Alembic migrations. The framework supports them via
shopdb/plugins/migrations.py; bundled plugins still rely ondb.create_all(). Move each bundled plugin onto its own version chain before sister sites adopt.
Nice-to-have
measuringtoolsplugin built using the scaffold (validates the scaffold under realistic conditions).- Frontend scaffolding skill (the backend has
flask plugin new; the frontend stub is currently manual copy-paste). - Marketplace listing site (PLUGINS.md is a one-pager; a proper listing with links to sister-site plugins becomes useful when there are more than three external plugins).
- Plugin contract surface diff tooling. Today version bumps are manual judgment; a CI check that diffs the contract surface against the previous tag would catch missed bumps. See ADR-002.
- Calibration cycles, maintenance windows, downtime tracking (domain extensions; would likely live in the
equipmentandmeasuringtoolsplugins).
Deferred (out of scope for 1.0)
- Multi-tenancy (rejected by ADR-004; revisit only if more than five sites adopt and operational overhead becomes painful).
- Pip-installable plugins (deferred per ADR-003 v2). Filesystem distribution stays the v1 model.
- Event bus on
BasePlugin(removed per ADR-001; add via new ADR if a real use case appears). - Frontend rebuild beyond Vue 3 + Pinia + Vite (the existing stack is fine).
What 1.0.0 means
Tagging 1.0.0 is a commitment that the contract surface is stable for at least the next minor version cycle. Plugin authors at sister sites can pin core_version: ">=1.0.0,<2.0.0" and trust their plugin will not break on framework patches.
Concretely, 1.0.0 ships when:
- ADR-001's full contract surface is implemented in code, not just documented (
Asset.mapx,RelationshipType.propagatesthroughid, etc.) - The contract test suite covers every documented hook with both happy-path and a "broken plugin" failure-isolation test
- At least one external plugin (likely
measuringtoolsfrom the scaffold canary) has been built end-to-end with no contract changes required mid-build - The deploy runbook (DEPLOY.md) has been validated by an actual fresh-host deploy
Decision log pointers
When a roadmap item gets prioritized, document the why in a new ADR and link from this file. The ADRs are the canonical source for design decisions; this file is the prioritized backlog.