Skip to content
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 pre-commit config and dependencies-update #60

Merged
merged 1 commit into from
Dec 7, 2024

Conversation

nikhilbadyal
Copy link
Owner

@nikhilbadyal nikhilbadyal commented Dec 7, 2024

Summary by Sourcery

Update pre-commit configuration and dependencies, remove unused hooks, and clarify README description.

Build:

  • Update pre-commit configuration to change default stages from 'commit' to 'pre-commit'.

Documentation:

  • Update README to reflect that the utility is now both a CLI and a module.

Chores:

  • Remove unused pre-commit hooks for pycln and docformatter.

@nikhilbadyal nikhilbadyal self-assigned this Dec 7, 2024
Copy link

sourcery-ai bot commented Dec 7, 2024

Reviewer's Guide by Sourcery

This PR updates the project's pre-commit configuration and dependencies. The main changes include simplifying the pre-commit hooks by removing pycln and docformatter, updating package versions in requirements.txt, and making minor documentation improvements.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modified pre-commit configuration to simplify hooks and change default stage
  • Changed default_stages from 'commit' to 'pre-commit'
  • Removed pycln hook for unused import removal
  • Removed docformatter hook for Python docstring formatting
.pre-commit-config.yaml
Updated project dependencies to newer versions
  • Updated loguru from 0.7.2 to 0.7.3
  • Updated tqdm from 4.66.5 to 4.67.1
requirements.txt
Enhanced project description in documentation
  • Updated README description to mention the project can be used as both a CLI utility and a module
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nikhilbadyal - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you explain the rationale for removing the pycln and docformatter pre-commit hooks? These tools help maintain code quality and documentation consistency.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Dec 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e0eabde) to head (6b844f7).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #60   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          338       338           
=========================================
  Hits           338       338           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nikhilbadyal nikhilbadyal merged commit 9791b3f into main Dec 7, 2024
9 checks passed
@nikhilbadyal nikhilbadyal deleted the dependencies-update branch December 7, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant