Skip to content

build(python)!: rename distribution to openae-core - #23

Merged
lukasberbuer merged 1 commit into
mainfrom
build/rename-python-distribution
Sep 9, 2026
Merged

build(python)!: rename distribution to openae-core#23
lukasberbuer merged 1 commit into
mainfrom
build/rename-python-distribution

Conversation

@lukasberbuer

@lukasberbuer lukasberbuer commented Sep 9, 2026

Copy link
Copy Markdown
Member

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.

Summary by CodeRabbit

  • New Features

    • The Python package is now published on PyPI as openae-core.
    • New releases are automatically published to PyPI.
  • Documentation

    • Updated installation instructions to use pip install openae-core.
    • Clarified that the package name changed, while Python imports remain openae.features.
    • Updated documentation to reflect the new package metadata and namespace package support.

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.
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 86b903c0-3a97-49e9-bec8-5b315b4286d6

📥 Commits

Reviewing files that changed from the base of the PR and between 6488b85 and 7df6396.

📒 Files selected for processing (7)
  • .github/workflows/python.yml
  • CHANGELOG.md
  • bindings/python/src/openae/__init__.py
  • docs/conf.py
  • docs/python/api.rst
  • docs/python/get-started.md
  • pyproject.toml
💤 Files with no reviewable changes (2)
  • bindings/python/src/openae/init.py
  • docs/python/api.rst

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The project is renamed to openae-core for distribution and PyPI publishing. Documentation reflects the new install name while imports remain openae.features. Published releases now trigger PyPI publishing, while pushes continue to target TestPyPI.

Changes

Distribution release

Layer / File(s) Summary
Distribution identity and documentation
pyproject.toml, bindings/python/src/openae/__init__.py, CHANGELOG.md, docs/conf.py, docs/python/api.rst, docs/python/get-started.md
The distribution name changes to openae-core. The empty openae module supports namespace packaging. Documentation uses the new package name and retains the openae.features import path.
Release publishing workflow
.github/workflows/python.yml
Published releases trigger PyPI publishing from built artifacts. Push events continue to publish to TestPyPI under the openae-core project URL.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 7df63

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
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: renaming the Python distribution to openae-core.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch build/rename-python-distribution

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.

@lukasberbuer
lukasberbuer merged commit e03d92f into main Sep 9, 2026
38 checks passed
@lukasberbuer
lukasberbuer deleted the build/rename-python-distribution branch September 9, 2026 10:05
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