Apply release-audit fixes for the 0.1.0 release candidate - #26
Merged
Conversation
- Relicense from Apache-2.0 WITH LLVM-exception to plain Apache-2.0: strip the exception from LICENSE and update the SPDX expression in pyproject.toml, every SPDX header, and the README license section (plain Apache-2.0 is also detectable by GitHub's license tooling). - Add SPDX headers to the four files that were missing them. - Fix the "Unsuported" -> "Unsupported" typo in error messages and the matching test assertions. - README: use absolute raw.githubusercontent.com image URLs and replace GFM footnotes with a plain-numbered References section so the page renders correctly on PyPI (which resolves no relative URLs and does not support footnotes); link the benchmark file and LICENSE. - Docs: add a Usage page including the README's Jitted Use and Spline Options sections (new doc:jitted/doc:options markers) so the numba-facing API is documented on the Sphinx site too. - Packaging: sharpen the PyPI one-line description, add the Software Development :: Libraries classifier and a Changelog URL, and add MANIFEST.in so the sdist deliberately ships tests/, CHANGELOG.md, and CITATION.cff. - Add CITATION.cff (with ORCID) for GitHub citation support and Zenodo release metadata, and a starter CHANGELOG.md. - Harden workflows: pin all actions to commit SHAs, set a workflow-level read-only GITHUB_TOKEN everywhere, and disable checkout credential persistence. - docs/conf.py: copyright year is now just 2026. Verified: full pytest suite (183 passed), prek run --all-files, sphinx -W docs build, uv build + twine check on both distributions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Owner
Author
|
Release-readiness review for PR #26, pinned to:
I reviewed the diff as a release-candidate readiness change set. I found no blocking issues and no evidence of unintended substantive code changes. What I checked:
Local verification:
Current PR checks are also green: build, coverage, floor, docs HTML, install floor/highest, mypy, prek, pydoclint, pylint, pyright, pytest, and skylos are passing. I could not run local |
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.
Mechanical fixes from the pre-release audit of PR #24. Merging this into
devupdates the release-candidate PR automatically.Apache-2.0 WITH LLVM-exceptionto plainApache-2.0(LICENSE text, pyproject SPDX expression, all SPDX headers, README); LICENSE copyright year bumped to 2026. Plain Apache-2.0 is also recognized by GitHub's license detection.pyakima/_version.py,docs/__init__.py,pyakima/demos/__init__.py,tests/__init__.py.Unsuported→Unsupportedin error messages plus the matching test assertions.raw.githubusercontent.comimage URLs, GFM footnotes converted to a plain-numbered References section (PyPI resolves no relative URLs and does not render footnotes), benchmark file and LICENSE now hyperlinked.doc:jitted/doc:optionsmarkers.Topic :: Software Development :: Libraries :: Python Modulesclassifier and a Changelog project URL;MANIFEST.inmakes the sdist deliberately shiptests/,CHANGELOG.md,CITATION.cff.CITATION.cff(with ORCID, feeds GitHub "Cite this repository" and Zenodo), starterCHANGELOG.md.permissions: contents: readeverywhere,persist-credentials: falseon every checkout.Verification
pytest: 183 passed (DTMCMC-dev env, numba 0.66/numpy 2.4.6)prek run --all-files: all hooks pass (including actionlint on the hardened workflows)sphinx -Wdocs build succeeds; Usage page and References renderuv build+twine check: both distributions pass; sdist/wheel contents inspected (wheel ships_version.py,demos/,py.typed; sdist adds tests + metadata files)🤖 Generated with Claude Code