Skip to content

adding the API contracts#7

Merged
MikeLippincott merged 11 commits intoWayScience:mainfrom
MikeLippincott:data_contracts
May 7, 2026
Merged

adding the API contracts#7
MikeLippincott merged 11 commits intoWayScience:mainfrom
MikeLippincott:data_contracts

Conversation

@MikeLippincott
Copy link
Copy Markdown
Member

Description

This PR adds data contracts for validating inputs and outputs. This is an initial step and will be added to as other modules get added in the future.

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Nice job! I'm requesting changes mainly because I think there's existing tooling you could make use of to reduce the amount of new code you need to create.

If you feel strongly about keeping things as-is just let me know and I'll circle back to give this more thought.

Comment thread README.md Outdated
Comment thread src/zedprofiler/contracts.py
Comment thread src/zedprofiler/contracts.py
Comment thread src/zedprofiler/contracts.py
Comment thread src/zedprofiler/contracts.py
Comment thread tests/conftest.py Outdated
Comment thread tests/conftest.py Outdated
Comment thread tests/conftest.py Outdated
Comment thread tests/test_package_exports.py Outdated
Comment thread pyproject.toml
@MikeLippincott MikeLippincott requested a review from d33bs May 6, 2026 18:24
Copy link
Copy Markdown
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Great work! LGTM, left a few comments about possible improvements.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread tests/test_update_coverage_badge.py
Comment thread src/zedprofiler/contracts.py
Comment thread src/zedprofiler/contracts.py
Comment thread src/zedprofiler/contracts.py Outdated
Comment thread src/zedprofiler/contracts.py Outdated
Comment thread tests/test_featurization_scaffolds.py Outdated
Comment thread .gitignore
Co-authored-by: Dave Bunten <ekgto445@gmail.com>
@MikeLippincott MikeLippincott merged commit 2037904 into WayScience:main May 7, 2026
0 of 14 checks passed
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.

3 participants