Skip to content

Fix install command in README.md#2048

Merged
frenck merged 1 commit intomainfrom
mik-laj-patch-1
Apr 17, 2026
Merged

Fix install command in README.md#2048
frenck merged 1 commit intomainfrom
mik-laj-patch-1

Conversation

@mik-laj
Copy link
Copy Markdown
Collaborator

@mik-laj mik-laj commented Apr 17, 2026

Proposed Changes

We need to install cli extras to run all tests.

Without CLI extras, tests failed with the following error:

_________________________________________________________________________________________ ERROR collecting tests/test_cli.py _________________________________________________________________________________________
ImportError while importing test module '/Users/kamil/devel/smart-home/home-assistant/python-wled/tests/test_cli.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
../../../../.pyenv/versions/3.14.0/lib/python3.14/importlib/__init__.py:88: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/test_cli.py:17: in <module>
    from wled.cli import cli
src/wled/cli/__init__.py:12: in <module>
    from zeroconf import ServiceStateChange, Zeroconf
E   ModuleNotFoundError: No module named 'zeroconf'

(Describe the changes and rationale behind them)

Related Issues

(GitHub link to related issues or pull requests)

Summary by CodeRabbit

  • Documentation
    • Updated development setup instructions to install additional optional dependencies when configuring the development environment.

Copilot AI review requested due to automatic review settings April 17, 2026 02:40
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 752e0e97-8fe5-49cf-bb6c-bcc8e6f3d225

📥 Commits

Reviewing files that changed from the base of the PR and between 47929d3 and 6881d94.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README development setup instructions were updated to use the --all-extras flag when installing dependencies via Poetry, ensuring all optional dependency groups are installed during environment initialization.

Changes

Cohort / File(s) Summary
Documentation
README.md
Updated Poetry installation command from poetry install to poetry install --all-extras to include all optional dependency groups in the development setup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

🐰 A simple hop through the docs we go,
With --all-extras flag aglow,
No dependency left behind,
A complete setup, designed with mind! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix install command in README.md' is concise and directly related to the changeset, which updates the README development setup command from 'poetry install' to 'poetry install --all-extras'.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mik-laj-patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the development setup instructions so contributors install the dependencies needed to run the full test suite (including the CLI-related optional dependencies).

Changes:

  • Update the README’s Poetry install command to install extras required by CLI tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
```bash
npm install
poetry install
poetry install --all-extras
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

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

README now recommends poetry install --all-extras, but the repo’s GitHub workflows install only the cli extra (poetry install --extras cli ...). Consider switching to --extras cli here to keep docs aligned with CI and avoid installing unrelated optional dependencies if more extras are added later.

Suggested change
poetry install --all-extras
poetry install --extras cli

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Owner

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @mik-laj 👍

../Frenck

                       

Blogging my personal ramblings at frenck.dev

@frenck frenck added the documentation Solely about the documentation of the project. label Apr 17, 2026
@frenck frenck merged commit ac2b60b into main Apr 17, 2026
33 of 34 checks passed
@frenck frenck deleted the mik-laj-patch-1 branch April 17, 2026 05:47
@github-actions github-actions bot locked and limited conversation to collaborators Apr 18, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Solely about the documentation of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants