Skip to content

Add documentation for building standalone .pyz package#46

Open
jiriskuta wants to merge 1 commit intomasterfrom
docs/add-pyz-build-instructions
Open

Add documentation for building standalone .pyz package#46
jiriskuta wants to merge 1 commit intomasterfrom
docs/add-pyz-build-instructions

Conversation

@jiriskuta
Copy link

@jiriskuta jiriskuta commented Feb 3, 2026

  • Add CLAUDE.md with project guidance for Claude Code
  • Add "Build Standalone Package (.pyz)" section to README
  • Fix pyproject.toml to include subpackages (external_server.*)

Note that CLAUDE.md is created automatically only by CC's /init command -> please check its contents and suggest changes if needed

Summary by CodeRabbit

  • Documentation

    • Added comprehensive developer guidance and setup documentation for the project
    • Added instructions for packaging as a standalone Python application (.pyz)
  • Chores

    • Updated build configuration for improved package discovery and handling

- Add CLAUDE.md with project guidance for Claude Code
- Add "Build Standalone Package (.pyz)" section to README
- Fix pyproject.toml to include subpackages (external_server.*)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 3, 2026

Walkthrough

Documentation updates added guidance for Claude Code integration (CLAUDE.md) and Python zipapp packaging instructions (README.md), along with a pyproject.toml modification to extend package discovery to include external_server submodules.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md, README.md
New and updated documentation files covering Claude Code guidance, project architecture, configuration schema, and standalone .pyz package creation using shiv.
Package Configuration
pyproject.toml
Modified setuptools discovery pattern to include external_server.* submodules alongside existing package entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Add documentation for building standalone .pyz package' directly and clearly reflects the main changes: adding build documentation for .pyz packaging in both CLAUDE.md and README.md, plus the supporting pyproject.toml fix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-pyz-build-instructions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 3, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants