docs: document local packaging flow and wheel metadata - #221
Conversation
Add a repository-level README that explains local editable installs, wheel builds, and downstream imports via dare_framework. Normalize client-facing command examples to use python -m pip/python -m client instead of hard-coded .venv paths so the docs work across environments. Wire pyproject readme metadata into the custom PEP 517 backend and add a regression test so built wheel metadata now includes the markdown README content.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3da1c7b58b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| readme = project.get("readme") | ||
| if isinstance(readme, str): | ||
| path = _project_root() / readme | ||
| return path.read_text(encoding="utf-8"), _infer_readme_content_type(path) |
There was a problem hiding this comment.
_metadata_text now always loads project.readme, and this line unconditionally reads README.md from disk, but build_sdist still does not include the repository root README.md in the tarball. As a result, pip wheel <generated-sdist> (or any metadata hook run from the unpacked sdist) fails with FileNotFoundError during prepare_metadata_for_build_wheel, so source-distribution installs are broken in that environment.
Useful? React with 👍 / 👎.
Include the configured project readme file in sdists so metadata hooks and wheel builds from generated source archives can still load README.md. Tighten the local backend regression test to assert the root README is present in the sdist archive and keep the markdown metadata coverage intact.
|
Addressed the review note about Fixed in
Verification:
Reference discussion: #221 (comment) |
|
@codex review |
|
Codex Review: Didn't find any major issues. Hooray! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
Summary
dare_frameworkimportspython -m pipandpython -m clientcommands instead of hard-coded.venv/bin/...pathsproject.readmemetadata plus custom backend support and regression coverage so built wheels expose the markdown README in package metadataVerification
/Users/lang/workspace/github/Deterministic-Agent-Runtime-Engine/.venv/bin/pytest -q/Users/lang/workspace/github/Deterministic-Agent-Runtime-Engine/.venv/bin/python -m pip wheel . -w /tmp/dare-local-package-readme-dist-2 --no-depsDescription-Content-Type: text/markdownand the README install section