Repository navigation
Rename Python package from pysvzerod to svzerod - #249
Merged
Merged
Conversation
1 task done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This renames the Python package so that the PyPI name and the import name are both
svzerod:pysvzerodwas only ever published to TestPyPI, never to pypi.org. Renaming now means the first production release ships under the new name.Breaking change
Code that uses
import pysvzerodhas to change toimport svzerod. The API itself is unchanged; only the module name is different.For existing source installs, run
pip uninstall pysvzerod, reinstall, and use a fresh CMake build directory. ThePYSVZEROD_VERSIONCMake cache variable is nowSVZEROD_VERSION.Changes
svzerodsolver/svzerodcalibratorentry points inpyproject.toml, and the extension name insetup.py.applications/pysvzerod.cppis renamed toapplications/svzerod.cpp, withPYBIND11_MODULE(svzerod, m). The CMake target is renamed tosvzerod, andPYSVZEROD_VERSIONis nowSVZEROD_VERSION..github/scripts/release_version.py: package index URLs, and the expected metadata name and file names.github/workflows/pypi.yml: sdist glob, release title and path filter.github/scripts/record_release.sh: release commit messagedocs/PYPI_RELEASE.md, the developer guide, the visualization page, comments in the workflows, and the profiling container paths.Before the next release
Trusted publishers registered for
pysvzeroddon't carry over to the new name. A maintainer needs to add a pending publisher forsvzerodon both TestPyPI and PyPI.Testing
svzerod-3.1.tar.gzandsvzerod-3.1-cp311-cp311-linux_x86_64.whl.release_version.py verify-distpasses on both.import svzerodworks andsvzerod.__version__is"3.1".pypi.yml:tests/test_solver.pyandtest_steady_flow_calibration: 40 passed, 2 xfailed. The xfails are the existing mismatched-period cases inEXPECTED_FAILURES.svzerodsolver tests/cases/steadyFlow_R_R.jsonruns successfully.pypi.ymlwheel builds on every platform, so CI covers those.Code of Conduct & Contributing Guidelines
🤖 Generated with Claude Code