Adding brew instructions and updating versions
#4547
Conversation
WalkthroughThe installation documentation for ESPHome has been updated to reflect changes in the required Python and ESPHome versions across different operating systems. Specifically, the Python version for Windows and Linux has been updated from 3.10.1 to 3.11.1, while the ESPHome version has been updated from 2021.12.3 to 2024.12.2 for both Windows and Mac sections. The Mac installation instructions have been revised to recommend Homebrew as the preferred installation method, with a new command for installation via Homebrew added. Additionally, the note regarding the installation process for Mac has been clarified. Changes
Suggested Reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
guides/installing_esphome.rst (2)
57-65: Add prerequisite information for Homebrew installationThe new Homebrew installation instructions are good, but consider adding:
- A link to Homebrew installation instructions
- Minimum system requirements
+When using macOS, you can install ESPHome using Homebrew. If you don't have Homebrew installed, +visit `Homebrew's website <https://brew.sh>`_ for installation instructions. + When `brew` is installed this will be the prefered method.
Line range hint
1-132: Documentation updates are comprehensive and well-structuredThe changes effectively achieve the PR objectives by:
- Consistently updating Python and ESPHome versions across all platforms
- Adding Homebrew installation method for Mac users
- Maintaining clear installation instructions for all platforms
Consider adding a note about minimum supported Python versions to help users with older installations.
+.. note:: + + ESPHome requires Python 3.9 or newer. While we recommend using Python 3.11.1, + any version from 3.9 onwards will work. +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
guides/installing_esphome.rst(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
guides/installing_esphome.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
🔇 Additional comments (2)
guides/installing_esphome.rst (2)
72-72: Version consistency looks good
The ESPHome version matches across all sections of the documentation.
83-83: Linux installation instructions are well-structured
The version updates are consistent with other sections, and the virtual environment setup instructions remain clear and helpful.
Also applies to: 118-118
guides/installing_esphome.rst
Outdated
| @@ -23,7 +23,7 @@ In the terminal that comes up, check that Python is installed: | |||
| .. code-block:: console | |||
|
|
|||
| > python --version | |||
| Python 3.10.1 | |||
| Python 3.11.1 | |||
There was a problem hiding this comment.
💡 Codebase verification
Python 3.11.1 version might be incompatible with ESPHome
Based on the requirements.txt check, there's a potential compatibility issue. The requirements file indicates a constraint async_timeout==4.0.3; python_version <= "3.10", suggesting that Python 3.11 might not be fully supported yet. Additionally:
- The ESPHome version (2024.12.2) matches the latest release, which is good
- However, the Python version 3.11.1 might be too new given the version constraint in requirements.txt
🔗 Analysis chain
Verify version compatibility
The Python and ESPHome version updates look good, but let's verify compatibility:
Also applies to: 47-47
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the specified Python version is supported by ESPHome
curl -s https://raw.githubusercontent.com/esphome/esphome/dev/requirements.txt | grep "python"
# Check if this is the latest stable ESPHome version
curl -s https://api.github.com/repos/esphome/esphome/releases/latest | jq -r .tag_name
Length of output: 240
Script:
#!/bin/bash
# Let's check the actual Python version requirements from setup.py or pyproject.toml
fd "setup.py|pyproject.toml" --exec cat {}
# Also check if there are any other Python version constraints in the docs
rg "python.*version|version.*python" -i guides/
Length of output: 203
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
- Python 3.10 instead of 3.11 - Link to Brew website
Description:
Found that the simple
brewinstallation method was not mentioned. Then I saw that for ESPhome and Python the versions were old.Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.