chore: rename repo to comfy-python-sdk and align README with sibling SDKs - #31
Conversation
…SDKs The repo moved from ComfyPythonSDK to comfy-python-sdk for consistency with the org's comfy-lower-kebab-case convention. Updates the URLs that pointed at the old name (project metadata, clone instructions, CodeRabbit context) and the public-repo hygiene allowlist, which is a literal name list and so does not follow GitHub's redirect. The PyPI package name is unchanged (`comfy-sdk`) — this is a repo rename only, so nothing breaks for installers. Also gives the README the same branded header the Swift SDK uses and turns "Related projects" into a linked table, so the three SDK READMEs open the same way.
|
Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories. Warning
|
| Layer / File(s) | Summary |
|---|---|
Metadata and review naming .coderabbit.yaml, pyproject.toml |
Review-tool instructions and package repository/issues URLs now reference comfy-python-sdk. |
Documentation branding and links README.md |
README branding, badges, source-install commands, and related-project references were updated for the current repository naming. |
Public repository validation scripts/check_public_repo_hygiene.py |
The allowlist now recognizes the lowercase hyphenated Comfy SDK repository names and removes legacy variants. |
Suggested reviewers: alexisrolland, bigcat88, coderfromthenorth93
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
chore/rename-repo-and-readme
✨ Simplify code
- Create PR with simplified code
- Commit simplified code in branch
chore/rename-repo-and-readme
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.
Comment @coderabbitai help to get the list of available commands.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.coderabbit.yaml:
- Line 5: Shorten the tone_instructions value in the CodeRabbit configuration to
250 characters or fewer while preserving the naming update; trim only the
surrounding prose and ensure the resulting configuration remains valid.
In `@README.md`:
- Around line 1-21: Add the top-level Markdown heading “comfy-python-sdk” before
the opening branded <div> in README.md so the document satisfies MD041 while
preserving the existing centered HTML block.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 19570a29-47be-4c1f-b62c-73fb577c7f9e
⛔ Files ignored due to path filters (1)
assets/logo.svgis excluded by!**/*.svg
📒 Files selected for processing (4)
.coderabbit.yamlREADME.mdpyproject.tomlscripts/check_public_repo_hygiene.py
Follow-up to the repo rename
ComfyPythonSDK→comfy-python-sdk(org convention:comfy-lower-kebab-case).What changed
pyproject.toml[project.urls], the clone instructions in the README, and the CodeRabbit context line.scripts/check_public_repo_hygiene.py:PUBLIC_COMFY_ORG_REPOSis a literal name list, so unlike a URL it does not follow GitHub's redirect — the old names would have started failing the gate. Also addscomfy-swift-sdk, now that the READMEs link to it.Not changed
The PyPI package name is still
comfy-sdk. This is a repo rename only;pip install comfy-sdkis unaffected and no consumer has to do anything.Risk / verification
python3 scripts/check_public_repo_hygiene.py→OK: no internal-only references found.Needs to happen alongside this
The PyPI Trusted Publisher for
comfy-sdkis bound to the old repo name and must be repointed atcomfy-python-sdk, otherwise the next release fails OIDC verification. Tracked separately.