-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
Updated build code #38
Conversation
Reviewer's Guide by SourceryThis pull request updates the build code, focusing on the setup.py file and the pre-commit configuration. The changes include refactoring the version retrieval method, simplifying the package setup process, and updating dependencies. Class diagram for updated setup.py functionsclassDiagram
class Setup {
+List~str~ INSTALL_REQUIRES
+str MIN_OPENCV_VERSION
+List~Tuple~ CHOOSE_INSTALL_REQUIRES
+List~str~ get_install_requirements(List~str~ install_requires, List~Tuple~ choose_install_requires)
}
class Version {
+str get_version()
}
class Requirement {
+str choose_requirement(Tuple~str~ mains, str secondary)
}
Setup --> Version : uses
Setup --> Requirement : uses
note for Version "Refactored to use os.path.join instead of Path"
note for Requirement "Simplified logic for choosing requirements"
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 @ternaus - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider retaining important package metadata in setup.py (e.g., description, author, license, url). This information is crucial for proper package distribution and user information.
- The new version retrieval function in setup.py seems less robust and harder to maintain than the previous implementation. Consider reverting this change or improving the new implementation for better clarity and error handling.
- The removal of the long_description function may negatively impact the project's presentation on package indexes. Consider keeping this information, possibly by reading it from the README.md file.
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.
Summary by Sourcery
Refactor setup.py to streamline version retrieval and package requirement selection, update dependencies, and modify package metadata. Update pre-commit hook versions in the configuration file.
Enhancements:
Build:
CI: