Improves Mac install instructions

[heythisisnate]

Description:

Better guidance on how to install ESPHome on a Mac

Related issue (if applicable): NA

Pull request in esphome with YAML changes (if applicable): NA

Checklist:

• I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
  or

• I am merging into current because 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.rst when creating new documents for new components or cookbook.

[coderabbitai]

Walkthrough

The changes update the installation instructions for Mac users in the guides/installing_esphome.rst file. The focus is on emphasizing the use of Homebrew for installation and providing alternative Python installation methods.

Changes

Files	Change Summary
guides/…/installing_esphome.rst	Updated installation instructions for Mac users, emphasizing Homebrew and providing Python alternatives.

Tip

CodeRabbit can approve the review once CodeRabbit's comments are resolved

Enable the reviews.request_changes_workflow setting in your project's settings in CodeRabbit to approve the review once CodeRabbit's comments are resolved.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 14b3169 and d92c7d5.

Files selected for processing (1)

• guides/installing_esphome.rst (1 hunks)

Additional context used

Path-based instructions (1)

guides/installing_esphome.rst (1)

Pattern **: - Do not generate or add any sequence diagrams

Additional comments not posted (8)

guides/installing_esphome.rst (8)

52-52: LGTM!

The instructions for using Homebrew to install ESPHome are clear and concise.

---

54-54: LGTM!

The code block for the Homebrew installation command is accurate and follows the documentation style.

---

58-60: LGTM!

The instructions for alternative installation methods with an existing Python installation are clear and helpful.

---

62-62: LGTM!

The instructions to ensure Python 3.9 or above is running are precise and necessary.

---

64-64: LGTM!

The code block to check the Python version is accurate and follows the documentation style.

---

66-67: LGTM!

The example output for the Python version command is accurate and follows the documentation style.

---

69-69: LGTM!

The pip3 installation command for ESPHome is accurate and follows the documentation style.

---

71-71: LGTM!

The code block to test the ESPHome installation is accurate and follows the documentation style.

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	d92c7d5
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/668f414fd28fa500089293ff
😎 Deploy Preview	https://deploy-preview-4034--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[jesserockz]

Brew (and other system package installers) are "unsupported" as they are not maintained by core ESPHome maintainers and this is why we do not mention them in the documentation.

[heythisisnate]

hey @jesserockz, I get it that you don't want to take on support. But Homebrew in this case is just a wrapper around the PyPi packages (see the forumula source) which just makes it more convenient for Mac users to install. So you could make the argument that since the actual code installed by homebrew is the exact same PyPi package as you would get from pip, then you are actually maintaining it!

FWIW I've been using the homebrew package for ESPHome for a long time and never had any issue.

But I'll follow your lead and if you don't want Homebrew mentioned at all, what's the next best alternative? Mac has a suitable version of Python that's shipped with Xcode command line tools which an end-user can install with xcode-select --install. Once that's installed, the Mac user should have access to pip3 normally. Ok to mention that?

[esphome]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.