docs: comprehensive README for the full 35-family surface + install/PyPI - #2
Merged
Conversation
- Replace the stale ~7-family description with the complete Level-5 catalog (35 families / 258 ops), grouped by domain, incl. the wcp.graph capstone. - Add real installation instructions: PyPI (wcpd + extras), from source, Docker/GHCR, running the server, and a full Claude Desktop wiring guide with the ~/.wcp-outside-TCC pattern and macOS permission notes. - Document the security model (5 restricted opt-in scopes, sandbox, audit, no-escalation, honest OS walls), architecture, conformance, and the parked v0.2 roadmap. - Flag the missing LICENSE as a release prerequisite. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add Apache-2.0 LICENSE at repo root and in each package dir (so wheels/ sdists bundle it via setuptools' default license-files glob). - Fill pyproject metadata for wcpd and wcp-conformance: readme (long description), license, authors, keywords, classifiers (OSI license, OS, Python 3.10-3.12), and [project.urls]. - Rewrite reference/wcpd/README.md as the package's PyPI front page (accurate 35-family surface, install/run/security, Claude Desktop pointer). - Update root README license section to Apache-2.0. Verified: python -m build produces clean sdists+wheels for both packages; METADATA carries License/classifier/Project-URL/markdown description and the bundled LICENSE. Names 'wcpd' and 'wcp-conformance' are unclaimed on PyPI. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Rewrites the outdated README (it still described ~7 families) to reflect the shipped 35 families / 258 operations.
Adds:
wcp.graphRDF/PROV-O capstonepip install wcpd+[graph]/[linux-ax]/[windows-ax]extras), from source, Docker/GHCR, running the server~/.wcp-outside-TCC pattern, config JSON, macOS Accessibility/Screen-Recording permissions)Flags a release prerequisite: the repo has no
LICENSEfile — needs one (Apache-2.0 or MIT) before the first public PyPI release.Docs-only; no code touched.
🤖 Generated with Claude Code