Skip to content

Create python-app.yml#11

Merged
sjswerdloff merged 9 commits intomainfrom
sjswerdloff-patch-1
Mar 11, 2025
Merged

Create python-app.yml#11
sjswerdloff merged 9 commits intomainfrom
sjswerdloff-patch-1

Conversation

@sjswerdloff
Copy link
Owner

@sjswerdloff sjswerdloff commented Mar 11, 2025

Summary by Sourcery

Add a CI workflow to run tests and lint the code with Python 3.11.

CI:

  • Add a CI workflow to run tests and lint the code with Python 3.11 on push and pull request events.
  • Install Python dependencies using Poetry.
  • Lint the code with flake8.
  • Run tests with pytest.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 11, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new GitHub Actions workflow for Python applications. The workflow automates the process of installing Python dependencies, running tests, and linting the code. It uses Poetry for dependency management and includes steps for caching dependencies to improve build times.

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

File-Level Changes

Change Details Files
Creation of a new GitHub Actions workflow for Python applications.
  • Configured the workflow to trigger on push and pull requests to the main branch.
  • Defined a job named 'build' that runs on Ubuntu.
  • Added steps to checkout the code, set up Python 3.11, and install Poetry.
  • Configured Poetry to create virtual environments in the project directory.
  • Implemented caching for Poetry dependencies.
  • Installed project dependencies using Poetry.
  • Added linting with flake8.
  • Added tests with pytest.
.github/workflows/python-app.yml

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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
Contributor

@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 @sjswerdloff - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using python -m poetry instead of just poetry to ensure you're using the correct Poetry executable.
  • It's generally better to install all dependencies, including flake8 and pytest, using Poetry to manage the environment consistently.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@sjswerdloff sjswerdloff merged commit 1f2391a into main Mar 11, 2025
1 check passed
@sjswerdloff sjswerdloff deleted the sjswerdloff-patch-1 branch March 11, 2025 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant