Skip to content

first commit for first PR#2

Open
MikeLippincott wants to merge 2 commits intoWayScience:mainfrom
MikeLippincott:packaging_and_environment_baseline
Open

first commit for first PR#2
MikeLippincott wants to merge 2 commits intoWayScience:mainfrom
MikeLippincott:packaging_and_environment_baseline

Conversation

@MikeLippincott
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@MikeLippincott MikeLippincott requested a review from d33bs April 9, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants