-
Notifications
You must be signed in to change notification settings - Fork 57
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WIP: Use Uv for managing packages and Ruff for code formatter. #534
Conversation
Reviewer's Guide by SourceryThis pull request introduces Uv for package management and Ruff for code formatting, aiming to improve dependency resolution and code consistency. It includes updates to project dependencies, CI configurations, test configurations, and documentation, along with the addition of pre-commit hooks for Ruff. Flow diagram: Updated development workflowflowchart TD
start[Developer starts work] --> uv[Install dependencies with Uv]
uv --> precommit[Install pre-commit hooks]
precommit --> code[Write code]
code --> ruff[Ruff auto-formats & lints]
ruff --> commit[Commit changes]
commit --> push[Push to repository]
push --> ci{CI Pipeline}
ci -->|Pass| merge[Ready to merge]
ci -->|Fail| code
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @hongquan - I've reviewed your changes - here's some feedback:
Overall Comments:
- Please remove the WIP tag from the title when this is ready for review. The changes look good but we want to make sure you consider it complete before doing a full review.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This reverts commit 05a6ee7.
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.
Hey @hongquan - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@@ -35,48 +37,66 @@ Your should install the following on your system: | |||
Your local python environment |
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.
issue (typo): Typo: "Your" should be "You"
Your local python environment | |
Your Local Python Environment |
|
||
`uv` automatically creates virtual environment in _.venv_ directory. | ||
If you want to create virtual environment outside the project directory, you can do so with | ||
a different tool and tell `uv` to repspect the activated virtual environment by setting the |
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.
issue (typo): Typo: "repspect" should be "respect"
a different tool and tell `uv` to repspect the activated virtual environment by setting the | |
a different tool and tell `uv` to respect the activated virtual environment by setting the |
The unittest run successfully on localhost (though still having failed cases) but get errors on GH Action. I will merge this PR and try to fix the GH Action later. |
Summary by Sourcery
Update project dependencies and switch to Ruff for code formatting.
Build:
CI:
Tests: