build(python)!: rename distribution to openae-core - #23
Conversation
PyPI prohibits the name `openae` as a typo-squat of `openai` (pypi/support#5968). Rename the distribution to `openae-core`, establishing the `openae-<component>` convention, and publish to PyPI on GitHub releases instead of TestPyPI only. The import name is unchanged: `pip install openae-core`, then `import openae.features`. Also drop `openae/__init__.py` to make `openae` a PEP 420 namespace package, so future `openae.*` distributions can extend it. Doing this later would break `import openae.ml` for anyone on an older release.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (7)
💤 Files with no reviewable changes (2)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe project is renamed to ChangesDistribution release
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~20 minutes Merge Risk: ⚪ Minimal · up to The package is installed as openae-core while retaining the openae.features import path, and published releases now publish to PyPI. The documented distribution and import behavior are aligned, with no concrete current merge-blocking risk identified. Sequence Diagram(s)sequenceDiagram
participant Release
participant GitHubActions
participant BuildArtifacts
participant PyPI
Release->>GitHubActions: Publish release
GitHubActions->>BuildArtifacts: Download wheels and sdist
GitHubActions->>GitHubActions: Remove Pyodide wheels
GitHubActions->>PyPI: Publish openae-core with trusted publishing
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
PyPI prohibits the name
openaeas a typo-squat ofopenai(pypi/support#5968). Rename the distribution toopenae-core, establishing theopenae-<component>convention, and publish to PyPI on GitHub releases instead of TestPyPI only.The import name is unchanged:
pip install openae-core, thenimport openae.features.Also drop
openae/__init__.pyto makeopenaea PEP 420 namespace package, so futureopenae.*distributions can extend it. Doing this later would breakimport openae.mlfor anyone on an older release.Summary by CodeRabbit
New Features
openae-core.Documentation
pip install openae-core.openae.features.