Open
Conversation
There was a problem hiding this comment.
Pull request overview
Initial repository scaffolding for the zedprofiler Python package, including baseline contracts/exceptions, placeholder featurization modules, and development/CI/docs tooling.
Changes:
- Added core package primitives (versioning, exceptions, input contracts) and scaffolded featurization modules.
- Introduced baseline tests plus CI/lint/coverage and dev workflow tooling (
uv,ruff,pytest-cov, Sphinx). - Added initial documentation set (README, roadmap, API docs, and RFC2119 naming spec draft).
Reviewed changes
Copilot reviewed 22 out of 26 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| zedprofiler/featurization/texture.py | Adds placeholder texture compute() scaffold that currently raises a package error. |
| zedprofiler/featurization/neighbors.py | Adds placeholder neighbors compute() scaffold that currently raises a package error. |
| zedprofiler/featurization/intensity.py | Adds placeholder intensity compute() scaffold that currently raises a package error. |
| zedprofiler/featurization/granularity.py | Adds placeholder granularity compute() scaffold that currently raises a package error. |
| zedprofiler/featurization/colocalization.py | Adds placeholder colocalization compute() scaffold that currently raises a package error. |
| zedprofiler/featurization/areasizeshape.py | Adds placeholder area/size/shape compute() scaffold that currently raises a package error. |
| zedprofiler/exceptions.py | Defines package exception hierarchy (ZedProfilerError, ContractError). |
| zedprofiler/contracts.py | Defines array shape/order contracts and common ndarray type aliases. |
| zedprofiler/_version.py | Introduces version source-of-truth (__version__ = "0.0.1"). |
| zedprofiler/init.py | Currently empty package init (affects version exposure expectations). |
| tests/test_package.py | Adds baseline tests for version exposure, contracts, and module importability. |
| tests/test_roadmap_scope.py | Empty placeholder test module. |
| ROADMAP.md | Adds multi-phase delivery plan and quality gates. |
| README.md | Adds initial project description, dev env command, and API-shape example. |
| pyproject.toml | Adds packaging metadata, deps/extras, and tool configs (pytest-cov gate, ruff). |
| justfile | Adds common dev commands for env sync, lint, and tests via uv. |
| docs/source/index.rst | Adds Sphinx landing page with toctree. |
| docs/source/conf.py | Adds Sphinx configuration and version loading from _version.py. |
| docs/source/api.rst | Adds API reference structure with autodoc modules. |
| docs/source/scope.rst | Empty placeholder scope page referenced by toctree. |
| docs/RFC-2119-Feature-Naming-Convention.md | Adds draft RFC2119 naming convention/specification document. |
| .python-version | Pins local Python version to 3.11. |
| .pre-commit-config.yaml | Adds pre-commit hook configuration (formatting/linting utilities). |
| .github/workflows/ci.yml | Adds CI running ruff, pytest with coverage gate, and Sphinx build. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds PR template checklist aligned with stated quality gates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This is the initial commit to layout the skeleton of the package. Argubly this is one of the most important PRs and also unfortunately, the most terse. The goal is uncompromisingly good software practices.