v0.1.4 - Milestone 4 Complete

Summary

Final release for Milestone 4 completing all DSCI 524 requirements.

Peer Review Feedback Addressed

Christine Chow's Review

Original issue: #55

Addressed by Yonas in PR #71

More details:

1. Shell command accessibility
   All $ prefixes have been removed from bash commands in the README. Additionally, each command is now placed in its own fenced code block to make copy-paste and step-by-step following easier.

2. quartodoc not found during build
   The issue was caused by quartodoc not being installed in the documentation environment, rather than Python version incompatibility. This has been fixed by explicitly including documentation dependencies in
   pip install -e ."[dev,test]" within the README.
   Python had already been pinned down to 3.13 to avoid compatibility issues.

3. Docstring consistency
   Docstrings have been unified for consistency across the codebase. All public functions now include a Raises section where applicable, and the structure of the Notes section has been standardized.

4. Citations and external references
   All external data-quality and schema-validation tools mentioned in the README now include direct hyperlinks in the Comparison subsection of the function reference, making it easier for users to explore related tools.

5. Code formatting / PEP 8
   All files are now formatted, and ruff check passes cleanly. You can also verify this in the CI build for PR #71, where the style-check step completes successfully.

Grigory Artazyan's Review

Original issue: #54

Addressed by Eduardo in PR #66

More details:

Changes made:

• Unified dependency management by cleaning up and aligning shared dependency configuration to avoid confusion and duplication.
• Fixed the TestPyPI download URL in pyproject.toml, which previously returned a 404.
• Removed example.py and its corresponding test file as they were no longer needed and cluttered the package.

Intentionally not changed:

• Function definitions, signatures, and internal logic were left untouched.
  Each core function (and its documentation/tests) is owned by an individual team member, and consistency or refactoring at that level is handled separately to avoid cross-ownership changes.

No functional behavior was modified as part of this PR; all changes are related to project hygiene, packaging, and peer-review-driven cleanup.

Gaurang Ahuja's Review

Original issue: #43

Addressed by Manikanth in PR #70

More details:

Added links to Pandera, Great Expectations, and Pydantic in the README.

Yuexiang Ni's Review

Original issue: #42

Addressed by Rahiq in PR #44 and issue #65

More details:

Fixed 3 out of 5 points from peer review:

1. Package name consistency throughout docs
2. Removed validate_and_fail reference
3. Confirmed result.ok usage is correct

What's Changed

• Add Netlify preview deployment for documentation PRs by @rahiqraees in #56
• Enhance documentation with complete runnable examples by @rahiqraees in #57
• Deploy documentation improvements to production by @rahiqraees in #58
• Improve documentation for infer_contract tests by @EduardoRasanmar in #60
• Address peer review feedback (Grigory's) by @EduardoRasanmar in #66
• Add Codecov coverage badge to README by @rahiqraees in #64
• Add semantic versioning with git tags by @rahiqraees in #63
• Enhance test documentation for summarize_violations by @rahiqraees in #62
• Docs/readmedocumentation by @goudmani in #67
• Updated Documentation of test_validate_contract by @goudmani in #69
• Addressing Gaurang's Peer review by @goudmani in #70
• Address Christine's Peer review by @yonasgebremarie in #71
• Remove uncessary workflow triggers by @yonasgebremarie in #72
• Enhance test documentaion for function compare contracts by @yonasgebremarie in #73
• Updated contribution.md with discussion about tools by @yonasgebremarie in #75
• CI: Add Codecov coverage upload by @EduardoRasanmar in #76

Full Changelog: 1.0.1...v0.1.4

Milestone 3 Release

Milestone 3 Release

Highlights

• Implemented/configured CI and CD workflows (GitHub Actions) for push/PR and TestPyPI deployment
• Added 4 additional unit tests for infer_contract
• Deployed package documentation using Quarto / quartodoc on GitHub Pages

1.0.0

Merge pull request #31 from UBC-MDS/validate_mani

Validate mani

0.0.1

Merge pull request #18 from UBC-MDS/yonas.readme

Update README with related packages and cleanup TODOs