dyson-ai / bencher

A package for benchmarking the characteristics of arbitrary functions
https://bencher.readthedocs.io/en/latest/
MIT License
2 stars 3 forks source link

Feature/update from template #437

Closed blooop closed 1 month ago

blooop commented 1 month ago

Summary by Sourcery

Enhance the project setup and CI by adding new features to the rename_project.sh script for updating author details, consolidating Python version badges in the README, updating dependencies in bencher.deps.yaml, and extending CI testing to include Python 3.12.

New Features:

Enhancements:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request updates the project template with several improvements to the project setup, configuration, and documentation. The changes include enhancements to the project renaming script, updates to the README, modifications to dependencies, and adjustments to the CI workflow.

File-Level Changes

Change Details Files
Enhanced project renaming script
  • Added functionality to replace author name, email, and GitHub username
  • Improved file exclusion logic in find commands
  • Removed 'update_from_template_ours.sh' from exclusion list
scripts/rename_project.sh
Updated README.md with improved badge display
  • Removed GitHub release badge
  • Consolidated Python version badges into a single badge
  • Removed separate 'Badges' section and Pixi badge explanation
README.md
Modified project dependencies
  • Added 'ca-certificates' to apt sources
  • Removed 'apt-utils' from apt tools
  • Replaced 'flit' and 'pip' with 'uv' in pip language-toolchain
bencher.deps.yaml
Updated CI workflow to include Python 3.12
  • Added 'py312' to the matrix of test environments
.github/workflows/ci.yml
Minor update to template update script
  • Added newline at the end of the file
scripts/update_from_template.sh

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.48%. Comparing base (4dbf951) to head (1916979). Report is 43 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #437 +/- ## ======================================= Coverage 90.48% 90.48% ======================================= Files 61 61 Lines 3384 3384 ======================================= Hits 3062 3062 Misses 322 322 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.