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

Fix devcontainer #516

Merged
merged 7 commits into from
Feb 14, 2025
Merged

Fix devcontainer #516

merged 7 commits into from
Feb 14, 2025

Conversation

pectum83
Copy link
Contributor

@pectum83 pectum83 commented Feb 14, 2025

Hi, I plan to add NAC netatmo clim in pyatmo in order to use it in home assistant.

This first PR is just about what I had to modify in order to build the devcontainer and have pytest pass on current dev branch. I am not sure it will work for any configuration but now it works for mine.

Summary by Sourcery

Update the development container configuration to resolve build issues and ensure tests pass. Update pre-commit hooks.

Build:

  • Update pre-commit hooks to v5.0.0 and add flake8.
  • Update devcontainer configuration to fix build issues and enable passing tests with pytest.

Copy link

sourcery-ai bot commented Feb 14, 2025

Reviewer's Guide by Sourcery

This pull request focuses on fixing the development container setup. It includes updates to pre-commit configurations and the Dockerfile to ensure a smoother development experience, particularly for building and testing the pyatmo library.

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

File-Level Changes

Change Details Files
Updated pre-commit configuration to include flake8 and updated ruff and pre-commit-hooks versions.
  • Added flake8 hook for linting.
  • Updated ruff version to v0.6.5.
  • Updated pre-commit-hooks version to v5.0.0.
  • Changed default stages to pre-commit and pre-push.
.pre-commit-config.yaml
Modified the Dockerfile and devcontainer.json for the development container.
  • Updated the Dockerfile.
  • Updated devcontainer.json.
.devcontainer/Dockerfile.dev
.devcontainer/devcontainer.json

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

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

Overall Comments:

  • It looks like you've made changes to the pre-commit configuration; please ensure these changes don't introduce new linting errors.
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.

exclude: ^(fixtures/)

repos:
- repo: https://github.com/pycqa/flake8
Copy link
Collaborator

Choose a reason for hiding this comment

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

Pyatmo has switched to ruff for style guide enforcement, so there is no need to reintroduce flake8.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok. I supressed it also in postCreateCommand of devcontainer


FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} as builder

SHELL ["/bin/bash", "-o", "pipefail", "-c"]

WORKDIR /workspaces

COPY Pipfile ./
COPY Pipfile* ./
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line could be remove as pyatmo no longer use pipenv

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, I also suppress all pipenv related lines

@pectum83 pectum83 requested a review from jabesq February 14, 2025 12:24
@pectum83
Copy link
Contributor Author

I did the changes. I am a beginner with github. Do I need to do something on the PR after I did new commits ?

Copy link
Collaborator

@jabesq jabesq left a comment

Choose a reason for hiding this comment

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

LGTM

@jabesq jabesq merged commit 8f3ab89 into jabesq-org:development Feb 14, 2025
5 checks passed
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.

2 participants