mmcdermott / MEDS_transforms

A simple set of MEDS polars-based ETL and transformation functions
MIT License
15 stars 3 forks source link

Release candidate for 0.0.4 #146

Closed mmcdermott closed 1 month ago

mmcdermott commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

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.

Changes

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.

Sequence Diagram(s)

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.