Repository navigation
Clean up packaging, CI and docs: drop Python 3.10, add 3.14, test minimum dependencies - #124
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #124 +/- ##
==========================================
- Coverage 61.84% 61.72% -0.13%
==========================================
Files 16 16
Lines 3182 3182
Branches 417 417
==========================================
- Hits 1968 1964 -4
- Misses 1046 1049 +3
- Partials 168 169 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review issues were identified, and the approval assessments are unanimous.
0 open findings
What changed in this PR
Modernizes packaging, CI, and documentation for Python 3.11–3.14, with updated dependency minimums and no API changes.
Changes:
- Updates packaging metadata and dependency requirements.
- Streamlines CI, build validation, and style checks.
- Removes obsolete setup, changelog, gallery, and tutorial placeholders.
- Cleans up affected docstrings and documentation configuration.
| File | Summary |
|---|---|
tutorials/README.rst |
Removes empty tutorial placeholder. |
setup.py |
Removes redundant setup shim. |
pyproject.toml |
Updates packaging, dependencies, and Ruff configuration. |
lapy/utils/_imports.py |
Fixes docstring spacing. |
lapy/utils/_config.py |
Fixes docstring spacing. |
examples/README.rst |
Removes empty gallery header. |
doc/index.rst |
Removes changelog navigation. |
doc/conf.py |
Removes obsolete documentation extensions. |
doc/changes/latest.rst.template |
Removes obsolete changelog template. |
doc/changes/latest.rst |
Removes obsolete changelog content. |
doc/changes/index.rst |
Removes obsolete changelog index. |
doc/changes/authors.inc |
Removes obsolete changelog authors file. |
doc/_templates/autosummary/function.rst |
Removes gallery sections. |
doc/_templates/autosummary/class.rst |
Removes gallery sections. |
.github/workflows/pytest.yml |
Updates Python matrices and adds minimum-dependency tests. |
.github/workflows/code-style.yml |
Replaces standalone pydocstyle checks with Ruff. |
.github/workflows/build.yml |
Simplifies builds and adds distribution validation. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Housekeeping for packaging, CI and the docs. No change to the LaPy API.
Packaging
setup.py. It only calledsetup(), whichpyproject.tomlmakes unnecessary.setuptools is now 77, the first version that understands
license = 'MIT'andlicense-files.requires-python >= 3.11and classifiers for 3.11 to 3.14. Python 3.10 reaches its endof life this month, and current numpy and scipy releases already need 3.11.
numpy>=1.23.2andscipy>=1.9.2, the first releases withPython 3.11 wheels, plus
nibabel>=4.0,plotly>=5.0andpsutil>=5.9. Before, numpy allowed versions that do notrun on any supported Python, and the other packages had no minimum at all.
fullextra, which only repeatedall.CI
only: 8 jobs instead of 12, or 15 with 3.14 added to the old matrix. Coverage is uploaded from ubuntu with 3.14.
pyproject.tomlallows(
uv pip install --resolution lowest-direct) on Python 3.11 and runs the tests, so the minimums stay true.pyproject.tomlor its own workflow changes, so dependency and CI changes get tested too.twine check --stricton thebuilt files. The package is pure Python and builds one
py3-none-anywheel for every platform, the release files arebuilt on ubuntu by the publish workflow, and the pytest jobs already install the package and run its entry point on
every OS.
pydocstyle, which is no longer maintained. This found 3 extra blank lines after docstrings, which are fixed.
Docs
ground. The
sphinx-issuesextension was only used there and is removed as well.minigallerysections. The notebook tutorials are rendered by nbsphinx and are unchanged.memory-profilerwas onlyneeded for the gallery and is dropped from the doc extras.
tutorials/folder and the gallery headerexamples/README.rst.Checks
ruff check .passes and the 145 tests pass with the current dependencies.145 tests pass as well.
sphinx-build -W --keep-goingas in CI. Compared with a build before these changes, only the twoempty gallery pages are gone.