chore: move deps from requirements.txt to pyproject.toml - #233
Merged
shenxianpeng merged 9 commits intoJun 1, 2025
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
Caution Review failedThe pull request is closed. ## Walkthrough
This update transitions the project's dependency management from requirements files to using package extras defined in `pyproject.toml`. It removes `requirements-dev.txt` and `docs/requirements.txt`, adjusts workflow and Gitpod commands, and updates `noxfile.py` to install dependencies via extras, streamlining development and documentation setup.
## Changes
| File(s) | Change Summary |
|------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| .github/workflows/main.yml, .gitpod.yml | Replaced explicit requirements file installation with package extras (`.[dev]`), simplified setup steps. |
| docs/requirements.txt, requirements-dev.txt | Deleted requirements files for docs and development dependencies. |
| noxfile.py | Removed REQUIREMENTS dict; sessions now install dependencies using package extras (`.[test]`, `.[docs]`).|
| pyproject.toml | Added `[project.optional-dependencies]` for `dev`, `test`, and `docs` extras. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant Developer
participant Workflow/Gitpod/Nox
participant Package Installer
Developer->>Workflow/Gitpod/Nox: Initiate environment setup
Workflow/Gitpod/Nox->>Package Installer: pip install .[dev] or .[docs]
Package Installer-->>Workflow/Gitpod/Nox: Installs dependencies from pyproject.toml extras
Workflow/Gitpod/Nox-->>Developer: Environment readyPossibly related PRs
Suggested labelsdocumentation Poem
<!-- walkthrough_end -->
<!-- internal state start -->
<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEejqANiS4NY+CtcjN8UyEu7IAZhRaQABg4AjtjwDmwYuIgauAAeuH6QBP7csrz4ImLRLBZ+BgBy2MwClFwATADM5QYAqoglkIiwZDHwmNxkREb6xuBQZPT4njgExGTKNPRMrOxcvPzCouJSMvJMSlSq6lo63SZQcKiomMOEpORUEwrTEVxUAO4NhcxoFPJyCusqapraumCGPVMBg0RHUsGwAgA9Hd7ABrTwWfB3RCQ57wDAaWTMCwcAwAIgJBgAxETIABBACSo3O1Doj1YL3kg0YsEwpEQZiakBhFHhiIeYRc0nQFgskBIMW4FngDHUyXg3BQGEQuDQot0fCCITC7EQYCUEmicQSU2eGFoyEw9AcUrQDGFuCazG5YPFYMoSpVaulGCIiS53DtsLQpBdjv8AG0DQBdBIS3BUZD2T2q0Xov1+DD4GJxyXS2W4CyyDSQClYR0kSACEIWehWtz4BjIISCRAAGn9lZVJEVjuoKe9dINJER3HCuEgWtCJHHXh8zork5IwWns8gnngVhQyBtFjtdPeaAaNF7rIn2G4RCoSmQ3AV6HNA9FyEz2YSElayVkjvwWDAzrvRV0S9dUsxzEsy07J8xRbAQO0XYDUz3cRf34IZh1Hcc3B7foyFlYVEDudRbGFbxfGwRB0ygqcdQiLxN0rJJEO9KjF0DBhg1DIjwz8KMSAkWNxTiRNIA/I8/EA6DIA0PiBL8Es4GkStbDZYUR3gZh0VpNxpzESAKJDStmUXGiZ11fV+KNCcNy3dF1zQCRk2ZZi019bCpEw9hsPac08PgB1YB8bAiFgKD2M4yt4xE5MXJ9DMwNzKUZUsYsjCMElyQsGgLngX9kCSRclAYPccrytChO4exLmTbgIXzcUInUfyOXyX8SA0fFCQMCAwCMEF1Eq2hMWxXECTxYlSUpalxjpRAnkZcqVN9aROUreTQVwQbhpyBQMA3IhsFKrA7jQZBnFoeANzpJJKOYJLPHkRc6lwC9ElO2ErjNC0FK5Pxik8ewSASbtFSzSBEWWvhYvy37TNnCzDVieJvNwjB8OQCUkoLIsAG4UAnLMHl/It9Mva9hQkhV5JgX7TStYGT25U6WVU+gyOdWLWIDINDKVcULtVAQt3OysAApKaA5UkN0SsND8ABKRJ8GgrnK3C3m7LodQVGFxRK240LFz8A1cwTZnxck2KZek2TY3ln61vRdQGZ7SdsAwDAqIkhwwFNOVYoSMJtGVfS0dZZahrSibMuy6hcpDgquSKkq47K5lMaqukarqmUGvEcQVta8gOrGrogVoRsUTh3UrNGwkMqms4ZvoOaGVeRbw/ZVb1wY/wK6bSFq7oqyEhO5AlCsCYftQGzlN/VV0WumE84oZquCPSjfS3CuJ3FuXFfrNiedDPxEG4BAMBiMANOebLWhyEsACUZxcLmZ979TNIwWkYa7dpZQ3AwVOWBjJNDqCjXyaNmrrmTIVRshR2DAIah+HwGBxwOwcNuSAYM0C0AFvHNU4N8CggYB2SgPg+Dh1oHFDsyYmARB8GKBESIlSOQsFIOsMN35bmJvIaU3Z6Dq1DEPSIHU0oNyyuMeO+VlaFVECnFCId06SkzgMPgtUha53YE1QueQ2qdXGt1IEYFZ4aBSHXcaDcqRNwuLNea7dmRLS7gYRSLNlo7hfq4I2j8ACiABFaoFJfEAFkfF5GgAAZQSBdMQBD259gnM8bg7R6BkBQb+LC382AyKXCuWikQe5WCiDTNaTApBUFIH4DsxtK5VIfPQGpTYAD60opDA2kJRMqYMIakChlLb0EClBQOFO8BwnhKB+TcpjfMcoRH0SKWGUKfgwAUGpmWbsuD4JNHkFbdwqN0b6U3n6IRkVhLM0QLICIaAYhcD8AAchkjQFU0Y7kJABnwRcZTlChjqIgTpWB6z3Jkv3RALy3mwKTpXepDZmmtK7B06RDs+6VxaZIIGDQEWoW6b+Xp0EXx4jPhfK+aA8CCBrLQPEiUZmFnkGqHFlElDUWXNqMydEqx4CXNKAi+ArAk1QkbB5UZK5gqEmbYprihRUHVL8/5RCSHQvoQmHl65+RLjRFgd2Ti6AdgNvwDAJNFxsB/AMdCOFIEMB2f00USC1TZTpOzXJLK1yzxySc0ViYxHpUmpIo6OS5HFReMApMQwM4UGquonODA846JalAZ+zgOGQCIIiAQhCJAvFaELNaviAlBJ8aE8JUSdKxN/AtB1r4YimJSPJbqkA9FuPZErdcmrFH8D4DK+ODR4BEG/i9BwUQDFl16gYFIaQMiaAICNQdVjpq2JbvYpkQwtUtVcRJVIPhx1ZGxG83uY9Sa0FpPQJIuC6zYJIA8XiY7FgaHwNwRRaoLI+SGejQSdQS3ljPNhDc5AYYOCMneghYo9nmvkFefAF5EC3JNtUp58QOyApBdTVdJsk1BUlsVbAN4oIVoSCcrZa1YMJDA69dEGGsN+C+RUoG1SUiEfg4+NdsH/yNlhHUw+v1EOofA+hiwmGKaEvRFfG+tJV5qgSICgTl8wAkoINWTctBqb1vwBWPgy6m1Xr0ka3B1AjzJjk7WXa+1DpILuBMpwuD2pRwkbHRRfqk7yMDbZ8qobw08EjdGgusa63KzU0kFzWcI2aKjdozzdzsIBt9dyMzzwlAly6j1IwcyEa12nZNaxYw530meA4pdndC6uO0ZgxVXlQFrSSwaEehT9bM0FBw6e8y1YOA/OBxAJN+GXAwrerCwHn3QNI7xi6blKO81Fu8pwJBTqHSomsOe5TDLy3gzpBwekADi6gAASEIlyVUogQduYyJlo0YrIrkyFpCJODlWKgYdypGwSicW+naCA8o7LwEgvsWCaV3mNs0IYqIbUgHYfAsJEALZ4N+c7kBRvJgoO7T2blYOg/o4IiHKpmMcShz9ljVE7KI/tpAAAQvICeJBxAI4QA1+D6oKzgM62OLyPW/LCheJWbFkNwslTpLjinjrVy6iq566OZIfVBqbf6hR0jnMqLDQFtzQWPPNSMHo4ug6jEAj2A1E1JxZ2Hs+jMScaAHit2y28VYesNjfG2H8QwGu/a4CafAC0TSmv+VM7QJpXow3W8BFAAAHAANgAAy+4AKwAHZygh4ACwMFKAATgEAARkD2H2gAhfcB/KAwWgDBA+J7QInuPQDyhh6j7QOPceo+lG9xr2gpQGCVED6UNAqeBAMH9/7zwuDE/+7D4nqP5QSDlDQJ3sPQfA8MCTyHwP/vfdRu6AYW3n31AO6dy789dAmn9Gt0AA= -->
<!-- internal state end -->
---
<details>
<summary>📜 Recent review details</summary>
**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**
<details>
<summary>📥 Commits</summary>
Reviewing files that changed from the base of the PR and between d2c3302a7dbc66fad167143e3a6f7600cb15068c and 2cb7753d98673d57ae2f1286c4a34570d7a32219.
</details>
<details>
<summary>📒 Files selected for processing (2)</summary>
* `noxfile.py` (1 hunks)
* `pyproject.toml` (1 hunks)
</details>
</details>
<!-- finishing_touch_checkbox_start -->
<details open="true">
<summary>✨ Finishing Touches</summary>
- [ ] <!-- {"checkboxId": "7962f53c-55bc-4827-bfbf-6a18da830691"} --> 📝 Generate Docstrings
</details>
<!-- finishing_touch_checkbox_end -->
<!-- tips_start -->
---
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
<details>
<summary>❤️ Share</summary>
- [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)
</details>
<details>
<summary>🪧 Tips</summary>
### Chat
There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=commit-check/commit-check&utm_content=233):
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- `I pushed a fix in commit <commit_id>, please review it.`
- `Explain this complex logic.`
- `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 explain this code block.`
- `@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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
- `@coderabbitai read src/utils.ts and explain its main purpose.`
- `@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.`
### Support
Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.
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 using 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 generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this 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.
### Other keywords and placeholders
- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.
### 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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
</details>
<!-- tips_end -->
|
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review detailsConfiguration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Reviewing files that changed from the base of the PR and between 742fc42 and 8608573.
📒 Files selected for processing (6)- .github/workflows/main.yml (1 hunks)
- .gitpod.yml (1 hunks)
- docs/requirements.txt (0 hunks)
- noxfile.py (2 hunks)
- pyproject.toml (1 hunks)
- requirements-dev.txt (0 hunks)
- docs/requirements.txt
- requirements-dev.txt
[convention] 67-67: Missing function or method docstring
(C0116)
🔇 Additional comments (3)pyproject.toml (1)43-53: LGTM! Clean dependency group implementation.
The dependency groups are well-structured and follow PEP 735 standards. The separation of dev and docs dependencies is logical, and including "." in the docs group ensures the current package is available for documentation builds.
.gitpod.yml (1)6-8: LGTM! Correctly updated for dependency groups.
The changes properly transition from installing requirements-dev.txt to using the new [dev] dependency group. This simplifies the setup process while maintaining the same functionality.
.github/workflows/main.yml (1)64-65: LGTM! Workflow correctly updated for dependency groups.
The installation command properly uses the new [dev] dependency group instead of requirements files, maintaining consistency with the project's transition to pyproject.toml-based dependency management.
Sorry, something went wrong.
Comment thread
noxfile.py
Outdated
Comment thread
noxfile.py
Outdated
Comment thread
noxfile.py
Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Codecov ReportAll modified and coverable lines are covered by tests ✅ Additional details and impacted files @@ Coverage Diff @@
## main #233 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 290 290
=========================================
Hits 290 290 ☔ View full report in Codecov by Sentry.
|
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)noxfile.py (1)📜 Review details64-67: LGTM! Correct implementation of package extras with additional dependency.
The docs-live session correctly combines package extras '.[docs]' with the additional "sphinx-autobuild" package. The syntax is proper and maintains the intended functionality.
Note: Static analysis suggests adding a docstring for this function, but this is a minor convention issue for nox session functions.
🧰 Tools 🪛 Pylint (3.3.7)[convention] 65-65: Missing function or method docstring
(C0116)
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Reviewing files that changed from the base of the PR and between 8608573 and d2c3302.
📒 Files selected for processing (3)- .github/workflows/main.yml (3 hunks)
- noxfile.py (1 hunks)
- pyproject.toml (1 hunks)
- .github/workflows/main.yml
- pyproject.toml
[convention] 59-59: Missing function or method docstring
(C0116)
[convention] 65-65: Missing function or method docstring
(C0116)
🔇 Additional comments (2)noxfile.py (2)51-55: LGTM! Correct implementation of package extras.
The transition from requirements files to package extras syntax is correctly implemented. The '.[test]' syntax properly installs the test dependencies defined in pyproject.toml.
🧰 Tools 🪛 Pylint (3.3.7)[convention] 51-51: Missing function or method docstring
(C0116)
58-61: LGTM! Correct implementation of package extras.
The docs session correctly uses package extras syntax with '.[docs]' to install documentation dependencies from pyproject.toml.
🧰 Tools 🪛 Pylint (3.3.7)[convention] 59-59: Missing function or method docstring
(C0116)
Sorry, something went wrong.
Copy link
Copy Markdown
|
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit