Closed mmcdermott closed 1 month ago
This update introduces several enhancements across the project, including a new .editorconfig
for consistent coding styles, automated workflows for building and publishing Python packages, and improved testing processes with JUnit reports. Additionally, documentation has been structured with MkDocs and Read the Docs configurations. The introduction of new features, such as a reshard_to_split
mechanism, further expands the functionality, ensuring better data handling and processing throughout the MEDS Transforms pipeline.
File(s) | Change Summary |
---|---|
.editorconfig |
New file added to establish coding style guidelines, including indentation, line endings, and specific settings for YAML files. |
.github/workflows/python-build.yaml |
New GitHub Actions workflow for building and publishing Python packages to PyPI and TestPyPI, including jobs for building, publishing, and releasing. |
.github/workflows/tests.yaml |
Enhancements to testing job, including JUnit XML report generation and Codecov result uploads. |
.pre-commit-config.yaml |
Updates to excluded files and added new Markdown formatting tools. |
.readthedocs.yaml |
New configuration file for building documentation with Read the Docs, specifying the build environment and package installation methods. |
docs/gen_ref_pages.py , docs/index.md |
New script for generating code reference pages and a new index file linking to the README for improved documentation navigation. |
docs/javascripts/mathjax.js |
New configuration for the MathJax library to render mathematical expressions in documentation. |
docs/pipeline_configuration.md , docs/preprocessing_operation_prototypes.md |
Formatting adjustments to enhance readability without changing content. |
mkdocs.yml |
New configuration file for MkDocs documentation site, including navigation structure and markdown extensions. |
pyproject.toml |
Addition of documentation dependencies and a new script entry for transformation functionality. |
src/MEDS_transforms/__init__.py |
New constants and data definitions added for mandatory columns and types, improving data handling. |
src/MEDS_transforms/aggregate_code_metadata.py |
New aggregation type for quantiles added with corresponding function and updates to existing mappings. |
src/MEDS_transforms/extract/... |
Various changes across multiple files, including adjustments to file paths, enhanced functionality, and updates to data handling. |
tests/... |
Significant enhancements to various test files, including consolidated import statements, new test functions, and improved testing frameworks. |
sequenceDiagram
participant User
participant GitHub
participant PyPI
participant Docs
User->>GitHub: Push code changes
GitHub->>GitHub: Run build workflow
GitHub->>PyPI: Publish package
GitHub->>Docs: Generate documentation
Docs-->>User: Access updated docs
🐇 In the land of code where changes grow,
A rabbit hops to share the flow.
With neat configs and workflows bright,
Our data dances in the light.
From docs to tests, all polished and grand,
Join the celebration, lend a hand! 🌟
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Summary by CodeRabbit
New Features
.editorconfig
file to enforce consistent coding styles across the project.Bug Fixes
Documentation
Tests
Chores