Skip to content

chore: rename repo to comfy-python-sdk and align README with sibling SDKs - #31

Merged
wei-hai merged 1 commit into
mainfrom
chore/rename-repo-and-readme
Jul 30, 2026
Merged

chore: rename repo to comfy-python-sdk and align README with sibling SDKs#31
wei-hai merged 1 commit into
mainfrom
chore/rename-repo-and-readme

Conversation

@wei-hai

@wei-hai wei-hai commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to the repo rename ComfyPythonSDKcomfy-python-sdk (org convention: comfy-lower-kebab-case).

What changed

  • URLs that pointed at the old repo name: pyproject.toml [project.urls], the clone instructions in the README, and the CodeRabbit context line.
  • scripts/check_public_repo_hygiene.py: PUBLIC_COMFY_ORG_REPOS is 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 adds comfy-swift-sdk, now that the READMEs link to it.
  • README: adopts the same branded header (logo + badge row) the Swift SDK already uses, and replaces the prose "Related projects" paragraph with a linked table. This is the consistency pass Alexis asked for — all three SDK READMEs now open identically and share one technical body style.

Not changed

The PyPI package name is still comfy-sdk. This is a repo rename only; pip install comfy-sdk is unaffected and no consumer has to do anything.

Risk / verification

  • python3 scripts/check_public_repo_hygiene.pyOK: no internal-only references found.
  • No source code touched — the diff is metadata, docs, and the hygiene allowlist.

Needs to happen alongside this

The PyPI Trusted Publisher for comfy-sdk is bound to the old repo name and must be repointed at comfy-python-sdk, otherwise the next release fails OIDC verification. Tracked separately.

…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.
@wei-hai
wei-hai requested review from a team as code owners July 30, 2026 19:38
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories.

Warning

.coderabbit.yaml has a parsing error

The CodeRabbit configuration file in this repository has a parsing error and default settings were used instead. Please fix the error(s) in the configuration file. You can initialize chat with CodeRabbit to get help with the configuration file.

💥 Parsing errors (1)
Validation error: Too big: expected string to have <=250 characters at "tone_instructions"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
📝 Walkthrough

Walkthrough

The SDK’s branding and repository references now use lowercase hyphenated names across review tooling, package metadata, README content, and public-repository hygiene validation.

Changes

Repository naming alignment

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.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between e1c94e1 and 864e4b6.

⛔ Files ignored due to path filters (1)
  • assets/logo.svg is excluded by !**/*.svg
📒 Files selected for processing (4)
  • .coderabbit.yaml
  • README.md
  • pyproject.toml
  • scripts/check_public_repo_hygiene.py

Comment thread .coderabbit.yaml
Comment thread README.md
@wei-hai
wei-hai merged commit 8688e9e into main Jul 30, 2026
10 checks passed
@wei-hai
wei-hai deleted the chore/rename-repo-and-readme branch July 30, 2026 19:52
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.

1 participant