[PR #31] [MERGED] chore: rename repo to comfy-python-sdk and align README with sibling SDKs #39

New issue

Closed

opened 2026-10-31 22:00:57 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:00:57 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/31
Author: @wei-hai
Created: 7/30/2026
Status: ✅ Merged
Merged: 7/30/2026
Merged by: @wei-hai

Base: main ← Head: chore/rename-repo-and-readme

📝 Commits (1)

864e4b6 chore: rename repo to comfy-python-sdk and align README with sibling SDKs

📊 Changes

5 files changed (+52 additions, -12 deletions)

View changed files

📝 .coderabbit.yaml (+1 -1)
📝 README.md (+34 -7)
➕ assets/logo.svg (+12 -0)
📝 pyproject.toml (+2 -2)
📝 scripts/check_public_repo_hygiene.py (+3 -2)

📄 Description

Follow-up to the repo rename ComfyPythonSDK → comfy-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.py → OK: 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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/31 **Author:** [@wei-hai](https://github.com/wei-hai) **Created:** 7/30/2026 **Status:** ✅ Merged **Merged:** 7/30/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `chore/rename-repo-and-readme` --- ### 📝 Commits (1) - [`864e4b6`](https://github.com/Comfy-Org/comfy-python-sdk/commit/864e4b68a8380ce33b825d135fbddf0f32606f2d) chore: rename repo to comfy-python-sdk and align README with sibling SDKs ### 📊 Changes **5 files changed** (+52 additions, -12 deletions) <details> <summary>View changed files</summary> 📝 `.coderabbit.yaml` (+1 -1) 📝 `README.md` (+34 -7) ➕ `assets/logo.svg` (+12 -0) 📝 `pyproject.toml` (+2 -2) 📝 `scripts/check_public_repo_hygiene.py` (+3 -2) </details> ### 📄 Description Follow-up to the repo rename `ComfyPythonSDK` → `comfy-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.py` → `OK: 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:00:57 +00:00