Skip to content

Update README & docs CI for Python 3.12 support#125

Draft
C-Achard wants to merge 6 commits into
mainfrom
cy/py312-readme
Draft

Update README & docs CI for Python 3.12 support#125
C-Achard wants to merge 6 commits into
mainfrom
cy/py312-readme

Conversation

@C-Achard
Copy link
Copy Markdown
Collaborator

This pull request updates the documentation and compatibility for the project to support Python 3.10 through 3.12, and addresses several deprecation issues for newer Python versions. It also updates the README with new badges and version information, and includes packaging improvements for more reproducible installs.

Python version compatibility updates:

  • Updated documentation to require Python 3.10 or higher in docs (.napari/DESCRIPTION.md, README.md). [1] [2]
  • Officially added support for Python 3.10–3.12, and removed references to Python 3.8 and 3.9 (README.md). [1] [2]

Documentation and packaging improvements:

  • Updated the README to show the new version (v0.2.3), added a Python version badge, replaced the Black code style badge with Ruff, and documented the addition of uv.lock for reproducible installs (README.md). [1] [2]
  • Noted several fixes for deprecation errors on newer Python versions in the changelog (README.md).

Code maintenance:

  • Removed outdated comments about MONAI API differences for Python 3.8/3.9 in model_SwinUNetR.py, reflecting the dropped support for older Python versions.

@C-Achard C-Achard added this to the Python 3.10-3.12 support milestone May 20, 2026
@C-Achard C-Achard self-assigned this May 20, 2026
@C-Achard C-Achard added the documentation Improvements or additions to documentation label May 20, 2026
@C-Achard C-Achard changed the title Update README for Python 3.12 support Update README & docs CI for Python 3.12 support May 20, 2026
C-Achard added 4 commits May 20, 2026 18:13
Add PyPI Python versions badge and replace the Black code-style badge with a Ruff badge. Bump release to v0.2.3 and include changelog entries (Python 3.10–3.12 support, deprecation fixes, packaging moved to pyproject.toml, added uv.lock) plus a warning about SwinUNetR `in_channels` issues. Update compatibility line to Python 3.10 to 3.12.
Bump and extend pre-commit configuration and migrate pyproject to a PEP 621 style layout. .pre-commit-config.yaml: update pre-commit-hooks rev, replace/update ruff hook to astral-sh/ruff-pre-commit with auto-fix and unsafe-fixes, add ruff-format, mdformat (with mdformat-myst), pyproject-fmt and validate-pyproject hooks; keep napari-plugin-checks. pyproject.toml: add [build-system], normalize project metadata (name, license, requires-python, classifiers), move authors to [[project.authors]], declare dynamic version, reorganize and deduplicate dependencies and optional-dependencies, add project.urls and napari entry-point, add [tool.setuptools] packaging settings, move and refine ruff configuration under [tool.ruff.lint], and add [tool.pyproject-fmt] settings. Overall this modernizes packaging and enables enhanced linting/formatting via pre-commit hooks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant