- Notifications
You must be signed in to change notification settings - Fork199
36 feat switch from pyinvoke to just#42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Hello@fmind, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request addresses issue#36 by switching the task management system frompyinvoke tojust. This involves removinginvoke and introducingjust for defining and running project tasks. The changes include updating the GitHub Actions workflows, pre-commit configuration, README,pyproject.toml, and task definitions to reflect this transition.
Highlights
- Task Management System Migration: Replaces
pyinvokewithjustfor task automation, aiming for a simpler and more straightforward task definition. - GitHub Actions Workflow Updates: Modifies the CI/CD workflows (
check.yml,publish.yml) to usejustcommands instead ofinvoke. - Pre-commit Configuration: Updates
.pre-commit-config.yamlto includebanditand upgrades the revisions ofpre-commit-hooksandcommitizen. - README Modifications: Updates the README to reflect the change from
pyinvoketojust, including updated command examples and task descriptions. - Dependency Management: Removes
invokeand addsrust-justas a development dependency inpyproject.toml. Also, addshatchlingas a dependency. - Task Definition Restructuring: Replaces the
invoke.yamlandtasks/*.pyfiles with a singlejustfilethat defines all project tasks.
Changelog
Click here to see the changelog
- .github/actions/setup/action.yml
- Updates the
setup-uvaction version fromv4tov5.
- Updates the
- .github/workflows/check.yml
- Replaces
invokecommands withjustcommands for running checks (format, type, code, security, coverage). - Changes the
uv syncgroup fromcheckstocheck.
- Replaces
- .github/workflows/publish.yml
- Replaces
invokecommands withjustcommands for documentation and package building. - Changes the
uv syncgroup fromdocstodoc.
- Replaces
- .pre-commit-config.yaml
- Updates the revision of
pre-commit-hookstov5.0.0. - Adds
bandithook for security checks. - Updates the revision of
commitizentov4.4.1.
- Updates the revision of
- README.md
- Updates references from
PyInvoketoJustin the Automation section. - Replaces
PyenvwithUvin the Programming section. - Updates command examples to use
justinstead ofinv. - Replaces the list of available tasks with a TOML-style configuration example for
just. - Updates descriptions and alternatives for task automation.
- Updates references from
- invoke.yaml
- Removes the
invoke.yamlfile asinvokeis no longer used.
- Removes the
- justfile
- Adds a
justfileto define project tasks usingjustsyntax, including tasks for checking, cleaning, committing, documenting, containerizing, formatting, installing, managing MLflow, packaging, and project management.
- Adds a
- mlops-python-package.code-workspace
- Removes the
vsc-invokeextension recommendation.
- Removes the
- pyproject.toml
- Moves
licenseandkeywordsto be beforerequires-python. - Adds
hatchlingas a dependency. - Renames dependency group
checkstocheck. - Replaces
invokewithrust-justin thedevdependency group. - Renames dependency group
docstodoc. - Renames dependency group
notebookstonotebook. - Updates
default-groupsintool.uvto reflect the dependency group renames.
- Moves
- python_env.yaml
- Removes the
python_env.yamlfile.
- Removes the
- requirements.txt
- Removes the
requirements.txtfile.
- Removes the
- tasks/init.py
- Removes the
tasks/__init__.pyfile.
- Removes the
- tasks/check.just
- Adds a
tasks/check.justfile.
- Adds a
- tasks/checks.py
- Removes the
tasks/checks.pyfile.
- Removes the
- tasks/clean.just
- Adds a
tasks/clean.justfile.
- Adds a
- tasks/cleans.py
- Removes the
tasks/cleans.pyfile.
- Removes the
- tasks/commit.just
- Adds a
tasks/commit.justfile.
- Adds a
- tasks/commits.py
- Removes the
tasks/commits.pyfile.
- Removes the
- tasks/containers.py
- Removes the
tasks/containers.pyfile.
- Removes the
- tasks/doc.just
- Adds a
tasks/doc.justfile.
- Adds a
- tasks/docker.just
- Adds a
tasks/docker.justfile.
- Adds a
- tasks/docs.py
- Removes the
tasks/docs.pyfile.
- Removes the
- tasks/format.just
- Adds a
tasks/format.justfile.
- Adds a
- tasks/formats.py
- Removes the
tasks/formats.pyfile.
- Removes the
- tasks/install.just
- Adds a
tasks/install.justfile.
- Adds a
- tasks/installs.py
- Removes the
tasks/installs.pyfile.
- Removes the
- tasks/mlflow.just
- Adds a
tasks/mlflow.justfile.
- Adds a
- tasks/mlflow.py
- Removes the
tasks/mlflow.pyfile.
- Removes the
- tasks/package.just
- Adds a
tasks/package.justfile.
- Adds a
- tasks/packages.py
- Removes the
tasks/packages.pyfile.
- Removes the
- tasks/project.just
- Adds a
tasks/project.justfile.
- Adds a
- tasks/projects.py
- Removes the
tasks/projects.pyfile.
- Removes the
- uv.lock
- Updates the
uv.lockfile to reflect the changes in dependencies, including the removal ofinvokeand the addition ofrust-justandhatchling.
- Updates the
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on ourdocumentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either/gemini <command> or@gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review | Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary | Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help | Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a.gemini/ folder in the base of the repository. Detailed instructions can be foundhere.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on@gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with theGemini Code Assist IDE Extension.
Did you know?
Thejust command runner is written in Rust, a systems programming language known for its speed, safety, and concurrency.
Footnotes
Review thePrivacy Notices,Generative AI Prohibited Use Policy,Terms of Service, and learn how to configure Gemini Code Assist in GitHubhere. Gemini can make mistakes, so double check it anduse code with caution.↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Code Review
This pull request introduces significant improvements to the project, including updating the Python version, transitioning fromPyInvoke toJust for task management, updating dependencies, and enhancing data validation in core models. The changes are well-structured and contribute to the project's maintainability, efficiency, and reliability.
Summary of Findings
- Python Version Updates: The pull request updates the Python version from 3.12 to 3.13 across multiple files, ensuring the project uses the latest features and improvements. This is a good practice for maintaining the project's currency and compatibility.
- Dependency Updates: The pull request updates various dependencies in
pyproject.tomlto their latest versions, ensuring the project benefits from the latest features, bug fixes, and security patches. This is crucial for maintaining the project's stability and security. - Transition from PyInvoke to Just: The pull request transitions the project's task management from
PyInvoketoJust, which offers a more straightforward and efficient syntax for defining and executing tasks. This simplifies the project's automation and improves developer experience. - Removal of
python_env.yamlandrequirements.txt: The pull request removes thepython_env.yamlandrequirements.txtfiles, relying instead onuvandpyproject.tomlfor managing dependencies. This streamlines the project's dependency management and reduces redundancy. - Improved Error Handling in
AlertsService: The pull request improves error handling in theAlertsServiceby printing a message to the console when notifications are not supported, rather than raising a warning. This provides a more user-friendly experience. - Data Validation in Core Models: The pull request introduces data validation using
panderaschemas in the core models, ensuring data integrity and preventing unexpected errors. This enhances the project's robustness and reliability.
Merge Readiness
The pull request is in good shape to be merged. The changes are well-structured and contribute to the project's maintainability, efficiency, and reliability. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.
22a0380 intov4.0.0Uh oh!
There was an error while loading.Please reload this page.
Closes#36