Remove references to Python 2 (#328)

This commit is contained in:
Fabian Affolter 2019-10-20 01:46:09 +05:30 committed by Otto Winter
parent d5bb10924b
commit 6c626e902d
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
5 changed files with 16 additions and 17 deletions

View File

@ -39,7 +39,7 @@ Because of this rename, ESPHome's installation methods have also changed (breaki
- **Hass.io**: The Hass.io addon repository has moved to `https://github.com/esphome/hassio <https://github.com/esphome/hassio>`__, - **Hass.io**: The Hass.io addon repository has moved to `https://github.com/esphome/hassio <https://github.com/esphome/hassio>`__,
please remove the old addon repository and add the new repository. please remove the old addon repository and add the new repository.
- **pip-based installs**: The new installation command is ``pip2 install esphome`` and - **pip-based installs**: The new installation command is ``pip install esphome`` and
the ``esphomeyaml`` command now is called ``esphome``. the ``esphomeyaml`` command now is called ``esphome``.
- **docker-based installs**: The docker image has moved to ``esphome/esphome``. So now you need - **docker-based installs**: The docker image has moved to ``esphome/esphome``. So now you need

View File

@ -167,7 +167,7 @@ Configuration variables:
To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
to translate the truetype files into an internal format. If you're running this as a Hass.io add-on or with to translate the truetype files into an internal format. If you're running this as a Hass.io add-on or with
the official ESPHome docker image, it should already be installed. Otherwise you need to install it using the official ESPHome docker image, it should already be installed. Otherwise you need to install it using
``pip2 install pillow``. ``pip install pillow``.
Then, in your display code just reference the font like so: Then, in your display code just reference the font like so:
@ -336,7 +336,7 @@ Configuration variables:
To use images you will need to have the python ``pillow`` package installed. To use images you will need to have the python ``pillow`` package installed.
If you're running this as a Hass.io add-on or with the official ESPHome docker image, it should already be If you're running this as a Hass.io add-on or with the official ESPHome docker image, it should already be
installed. Otherwise you need to install it using ``pip2 install pillow``. installed. Otherwise you need to install it using ``pip install pillow``.
And then later in code: And then later in code:

View File

@ -233,7 +233,7 @@ To check your documentation changes locally, you first need install Sphinx (with
.. code-block:: bash .. code-block:: bash
# in ESPHome-Docs repo: # in ESPHome-Docs repo:
pip3 install -r requirements.txt pip install -r requirements.txt
Then, use the provided Makefile to build the changes and start a simple web server: Then, use the provided Makefile to build the changes and start a simple web server:
@ -273,7 +273,7 @@ This is only possible for ``pip`` installs.
git clone https://github.com/esphome/esphome.git git clone https://github.com/esphome/esphome.git
git clone https://github.com/esphome/esphome-docs.git git clone https://github.com/esphome/esphome-docs.git
# Install esphome, python 2! # Install esphome
cd esphome/ cd esphome/
script/setup script/setup
# Start a new feature branch # Start a new feature branch

View File

@ -123,7 +123,7 @@ It's simple. Run:
.. code-block:: bash .. code-block:: bash
pip2 install -U esphome pip install -U esphome
# From docker: # From docker:
docker pull esphome/esphome:latest docker pull esphome/esphome:latest
@ -141,7 +141,7 @@ by installing the esphome beta:
.. code-block:: bash .. code-block:: bash
# For pip-based installs # For pip-based installs
pip2 install --pre -U esphome pip install --pre -U esphome
# For docker-based installs # For docker-based installs
docker run [...] -it esphome/esphome:beta livingroom.yaml run docker run [...] -it esphome/esphome:beta livingroom.yaml run

View File

@ -5,24 +5,23 @@ Getting Started with ESPHome
:description: Getting Started guide for installing ESPHome using the command line and creating a basic configuration. :description: Getting Started guide for installing ESPHome using the command line and creating a basic configuration.
:image: console.png :image: console.png
ESPHome is the perfect solution for creating custom firmware for ESPHome is the perfect solution for creating custom firmwares for
your ESP8266/ESP32 boards. In this guide well go through how to setup a your ESP8266/ESP32 boards. In this guide well go through how to set up a
basic “node” in a few simple steps. basic “node” in a few simple steps.
Installation Installation
------------ ------------
Installing ESPHome is very easy. All you need to do is have `Python Installing ESPHome is very easy. All you need to do is have `Python
2.7 <https://www.python.org/download/releases/2.7/>`__ installed <https://www.python.org/>`__ installed and install the console script script through
(because of platformio 😕) and install the console script script through
``pip``. ``pip``.
.. code-block:: bash .. code-block:: bash
pip install esphome pip install esphome
Alternatively, theres also a docker image available for easy Alternatively, theres also a Docker image available for easy
installation (the docker hub image is only available for amd64 right now; if you have installation (the Docker hub image is only available for amd64 right now; if you have
an RPi, please install ESPHome through ``pip`` or use :doc:`the Hass.io add-on <getting_started_hassio>`: an RPi, please install ESPHome through ``pip`` or use :doc:`the Hass.io add-on <getting_started_hassio>`:
.. code-block:: bash .. code-block:: bash
@ -145,13 +144,13 @@ for docker you need to supply an additional parameter:
Where To Go Next Where To Go Next
---------------- ----------------
Great 🎉! Youve now successfully setup your first ESPHome project Great 🎉! Youve now successfully set up your first ESPHome project
and uploaded your first ESPHome custom firmware to your node. Youve and uploaded your first ESPHome custom firmware to your node. Youve
also learned how to enable some basic components via the configuration also learned how to enable some basic components via the configuration
file. file.
So now is a great time to go take a look at the :doc:`Components Index </index>`. So now is a great time to go take a look at the :doc:`Components Index </index>`.
Hopefully youll find all sensors/outputs/ youll need in there. If youre having any problems or Hopefully youll find all sensors/outputs/etc. youll need in there. If youre having any problems or
want new features, please either create a new issue on the `GitHub issue want new features, please either create a new issue on the `GitHub issue
tracker <https://github.com/esphome/issues/issues>`__ or find us on the tracker <https://github.com/esphome/issues/issues>`__ or find us on the
`Discord chat <https://discord.gg/KhAMKrd>`__ (also make sure to read the :doc:`FAQ <faq>`). `Discord chat <https://discord.gg/KhAMKrd>`__ (also make sure to read the :doc:`FAQ <faq>`).
@ -170,10 +169,10 @@ To start the ESPHome dashboard, simply start ESPHome with the following command
.. code-block:: bash .. code-block:: bash
# Install dashboard dependencies # Install dashboard dependencies
pip2 install tornado esptool pip install tornado esptool
esphome config/ dashboard esphome config/ dashboard
# On docker, host networking mode is required for online status indicators # On Docker, host networking mode is required for online status indicators
docker run --rm --net=host -v "${PWD}":/config -it esphome/esphome docker run --rm --net=host -v "${PWD}":/config -it esphome/esphome
After that, you will be able to access the dashboard through ``localhost:6052``. After that, you will be able to access the dashboard through ``localhost:6052``.