fix: change project.entry-points.console_scripts to project.scripts in pyproject.toml
#743
Conversation
…s` in `pyproject.toml` `project.entry-points.console_scripts` is not allowed per [PEP 621](https://peps.python.org/pep-0621/).
njzjz
changed the title
project.entry-points.console_scripts to `project.script…project.entry-points.console_scripts to project.scripts in pyproject.toml
📝 WalkthroughWalkthroughThe changes in the pull request involve modifications to the Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pyproject.toml (1)
Line range hint
89-146: Consider addressing the TODO documentation rules in future updates.The tool configurations are well-structured, but there are several ignored documentation rules marked as TODO:
- D100-D105: Missing docstrings in various contexts
- D401: First line imperative mood
- D404: First word conventions
While not blocking for this PR, these could be addressed in a future update to improve code documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- pyproject.toml (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
pyproject.toml (2)
Line range hint
17-38: LGTM! Well-structured dependencies with clear constraints.The dependencies are properly organized with:
- Clear separation between core and optional dependencies
- Well-documented version constraints (especially the numpy constraint for tests)
- Appropriate Python version requirements
Also applies to: 44-67
40-41: LGTM! Entry point configuration updated to follow PEP 621.The change from
project.entry-points.console_scriptstoproject.scriptscorrectly implements PEP 621 compliance while maintaining the same functionality.Let's verify there are no other entry points that need similar updates:
✅ Verification successful
Let me try a different approach to verify if there are any remaining entry points configurations that need updates.
This will help us:
- Find any setup.py files that might contain legacy entry points configuration
- Locate all pyproject.toml files in the project
- Examine the content of pyproject.toml files to ensure all entry points are properly configured
Entry point configuration update is partially complete
The verification revealed that while the main
pyproject.tomlcorrectly uses the new PEP 621project.scriptsformat, there are still entry points using the old format in plugin-related files:
plugin_example/pyproject.toml: Usesproject.entry-points.'dpdata.plugins'tests/plugin/pyproject.toml: Usesproject.entry-points.'dpdata.plugins'However, it's important to note that these are different types of entry points. The
dpdata.pluginsentry points are for plugin registration, which is different from console scripts. The PEP 621 migration specifically targets console scripts, so these plugin entry points should remain as they are.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining entry-points.console_scripts configurations rg -l "entry-points\.console_scripts"Length of output: 39
Script:
#!/bin/bash # Search for any setup.py files that might contain entry points fd "setup.py$" # Search for any pyproject.toml files fd "pyproject.toml$" # If we find any pyproject.toml files, let's check their content fd "pyproject.toml$" -x cat {}Length of output: 4484
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #743 +/- ##
=======================================
Coverage 84.80% 84.80%
=======================================
Files 81 81
Lines 7336 7336
=======================================
Hits 6221 6221
Misses 1115 1115 ☔ View full report in Codecov by Sentry. |
CodSpeed Performance ReportMerging #743 will not alter performanceComparing Summary
|
project.entry-points.console_scriptsis not allowed per PEP 621.Summary by CodeRabbit
New Features
dpdatatool for improved accessibility.Chores