Skip to main content

Python Scripts

A template to use as a reference is ps-hacs

This is for the python_script integration in Home Assistant

Requirements​

For a python_script repository to be valid these are the requirements:

Repository structure​

  • The python script are located here ROOT_OF_THE_REPO/python_scripts/SCRIPT_NAME.py
  • There is only one python file (one directory under ROOT_OF_THE_REPO/python_scripts/) per repository (if you have more, only the first one will be managed.)

OK example:​

python_scripts/awesome.py
info.md
README.md

Not OK example:​

awesome.py
info.md
README.md

GitHub releases (optional)​

If there are releases​

When downloading/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to download a specific version. The choices will be the last 5 releases and the default branch.

If there are no releases​

It will scan files in the branch marked as default.