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.

Sign up for GitHub

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

Improves Mac install instructions #4034

Closed
wants to merge 3 commits into from
+18 −6
Closed

Improves Mac install instructions #4034

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
324bc34
Improves Mac install instructions
heythisisnate Jul 10, 2024
14b3169
fix links
heythisisnate Jul 11, 2024
d92c7d5
fix links
heythisisnate Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions guides/installing_esphome.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,26 @@ with the following:
Mac
---

There are no tested installation instructions for Mac. ESPHome does support
Mac & will run with no problem.
The simplest way to install ESPHome on a Mac is with `Homebrew <https://brew.sh/>`_:

Contributions are welcome!
.. code-block:: console
$ brew install esphome
Comment on lines -53 to +56
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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?

Or, if you have a working Python installation you can install it directly without Homebrew.
There are several ways to install Python on a Mac, including with Apple's Xcode command
line tools or from `Python downloads <https://www.python.org/downloads/>`_.

Make sure you're running python 3.9 or above, then install using ``pip3``:

.. code-block:: console
$ python3 --version
Python 3.9.15
$ pip3 install esphome
The process will likely be similar to Windows. You can install Python from the
official site, and then install ESPHome with ``pip3 install esphome``. You can
then test that things are properly installed with the following:
You can then test that things are properly installed with the following:

.. code-block:: console
Expand Down