chore: package as installable CLI + complete docs - #10
Merged
Conversation
Packaging: - Add [build-system] hatchling + tool.uv.package=true so qms-kit is a proper pip-installable CLI (was skipped before, entry point ignored) - hatchling added to dev dependencies Docs: - readme: fix docker-compose path, replace python -m cli with qms-kit, full 6-step quickstart, Phase 1 marked complete - docs/configuration.md: rewrite from TODO stub to full reference — all Pydantic model keys documented with types and descriptions, tracker_mapping example, validation error guide - docs/architecture.md: fix CLI invocation to qms-kit deploy - .markdownlint.json: disable MD033/MD060/MD013 (inline HTML and table pipe style are intentional in this repo) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Packaging
[build-system]with hatchling added —qms-kitis now a proper installable CLI, not just a script alias that uv silently skipstool.uv.package = trueeliminates the "Skipping installation of entry points" warning in CIuv sync,qms-kit --helpworks withoutpython -m cliDocs
readme.md: corrected docker-compose path (docker/notadapters/selfhosted/), replacedpython -m cliwithqms-kit, full 6-step quickstart, Phase 1 marked ✅ completedocs/configuration.md: full rewrite from TODO stub — all Pydantic model fields documented with types, defaults, and descriptions; tracker_mapping example; validation error guidedocs/architecture.md:qms-kit deployinstead ofpython -m cli deploy.markdownlint.json: disable MD033 (inline HTML used for centered README header), MD060 (table pipe style), MD013 (line length — unavoidable in link-heavy tables)Test plan
uv sync && qms-kit --helpworksqms-kit deploy --target selfhosted --config config/clients/example.yaml --dry-runworks🤖 Generated with Claude Code