Repository navigation
chore/repo housekeeping - #2
Merged
Merged
Conversation
dimitri-yatsenko
approved these changes
Jan 30, 2026
dimitri-yatsenko
left a comment
Member
There was a problem hiding this comment.
Review: Approved ✅
Comprehensive modernization following scientific-python best practices. Well done!
Summary of Changes
Build & Packaging:
- ✅ Dynamic versioning via
hatch-vcs(replaces hardcoded__version__) - ✅ Modern
pyproject.tomlconfiguration - ✅
noxfile.pyfor task automation (lint, test, docs, build)
CI/CD:
- ✅ New
ci.ymlwith multi-OS (ubuntu, windows, macos), multi-Python (3.10-3.14) matrix - ✅ New
cd.ymlfor PyPI publishing with attestation - ✅ Dependabot for automated dependency updates
- ✅ Concurrency controls to cancel stale runs
Code Quality:
- ✅ Comprehensive pre-commit config (ruff, mypy, codespell, prettier, blacken-docs)
- ✅
py.typedmarker for PEP 561 compliance - ✅ Type annotations added throughout
Code Fixes:
- ✅
zarr.open()→zarr.open_array()(correct API for arrays) - ✅ Fixed logging format strings (
%sinstead of f-strings) - ✅ Reproducible tests with
rng = np.random.default_rng(42) - ✅ Docker availability check in conftest.py
Documentation:
- ✅ MkDocs setup with material theme
- ✅ Comprehensive usage examples in docs/index.md
- ✅ CONTRIBUTING.md guide
Minor Notes
-
Python 3.14 in CI matrix - Not released yet; CI may fail until it's available. Consider using
3.13until 3.14 is released, or addallow-prereleases: true(which is already there, so should be fine). -
Test PyPI in cd.yml - Line 60 has
repository-url: https://test.pypi.org/legacy/with comment "Remove this line to publish to PyPI". Make sure to update before first production release.
LGTM! 🚀
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.
Organizes package according to best practices recommended by https://learn.scientific-python.org/development/guides/packaging-simple/
and adds simple docs