jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-04 10:08:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/developers/development_environment.markdown

1.5 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer
layout title description date sidebar comments sharing footer
page Set up Development Environment Set up your environment to start developing for Home Assistant. 2014-12-21 13:32 true false true true

You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.

  1. Visit the the Home Assistant repository and click "fork."

    • Consider setting up a virtual environment using venv before running the setup script.
    $ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
$ cd home-assistant
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
$ script/setup
    • On Windows, you can use python setup.py develop instead of the setup script.

  2. Run hass to invoke your local installation.

Developing on Windows

If you are using Windows as a development platform, make sure that you have the correct Microsoft Visual C++ build tools installed. Check the Windows Compilers section on the Python website for details. Validation using tox will fail if this is not done correctly.

Also, make sure to install or upgrade the Setuptools Python package -- it contains compatibility improvements and adds automatic use of compilers:

pip install --upgrade setuptools