hotfix #412
hotfix #412
Conversation
Reviewer's Guide by SourceryThis pull request introduces a new setup.py file to the project, which is essential for packaging and distributing the 'bencher' library. The setup.py file includes metadata about the package, such as its name, description, and test requirements. Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @blooop - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 4 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 to tell me if it was helpful.
| setup( | ||
| name=package_name, | ||
| description="A library for benchmarking code and generating reports for analysis", | ||
| # maintainer="austin.gregg-smith", |
There was a problem hiding this comment.
question: Commented-out maintainer information
The maintainer and maintainer_email fields are commented out. If this is intentional for a temporary reason, consider adding a comment explaining why. Otherwise, it might be better to either include or remove these lines.
| name=package_name, | ||
| description="A library for benchmarking code and generating reports for analysis", | ||
| # maintainer="austin.gregg-smith", | ||
| # maintainer_email="austin.gregg-smith@dyson.com", |
There was a problem hiding this comment.
question: Commented-out maintainer email
Similar to the maintainer field, the maintainer_email field is commented out. If this is intentional for a temporary reason, consider adding a comment explaining why. Otherwise, it might be better to either include or remove these lines.
| # maintainer_email="austin.gregg-smith@dyson.com", | ||
| packages=find_packages(exclude=["test.*", "test"]), | ||
| data_files=[ | ||
| ("share/ament_index/resource_index/packages", ["resource/" + package_name]), |
There was a problem hiding this comment.
suggestion: Hardcoded paths in data_files
Consider using os.path.join for constructing file paths to ensure compatibility across different operating systems.
| ("share/ament_index/resource_index/packages", ["resource/" + package_name]), | |
| import os | |
| data_files=[ | |
| ("share/ament_index/resource_index/packages", [os.path.join("resource", package_name)]), | |
| ("share/" + package_name, ["package.xml"]), | |
| ] |
| packages=find_packages(exclude=["test.*", "test"]), | ||
| data_files=[ | ||
| ("share/ament_index/resource_index/packages", ["resource/" + package_name]), | ||
| ("share/" + package_name, ["package.xml"]), |
There was a problem hiding this comment.
suggestion: Hardcoded paths in data_files
Similar to the previous line, consider using os.path.join for constructing file paths to ensure compatibility across different operating systems.
| ("share/" + package_name, ["package.xml"]), | |
| import os | |
| data_files=[ | |
| ("share/ament_index/resource_index/packages", ["resource/" + package_name]), | |
| (os.path.join("share", package_name), ["package.xml"]), | |
| ], |
|
|
||
| package_name = "bencher" | ||
|
|
||
| setup( |
There was a problem hiding this comment.
issue (code-quality): Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)
Summary by Sourcery
This pull request introduces a setup.py file to the project, enabling packaging and distribution of the 'bencher' library. The setup includes metadata, package discovery, data files, and test requirements.