Home Assistant custom component Cookiecutter

Project Status CalVer License
Read the documentation at https://cookiecutter-homeassistant-custom-component.readthedocs.io/
pre-commit Black

Cookiecutter template for a Home Assistant custom component based on the blueprint template.

This project is the fusion of cookiecutter-homeassistant-component, blueprint and cookiecutter-hypermodern-python projects.

Usage

$ cookiecutter gh:oncleben31/cookiecutter-homeassistant-custom-component \
  --checkout="2020.11.16"

Features

  • Ready to use Home Assistant custom component

  • UI configuration with config Flow

  • Translations

  • Development and testing in Visual Studio Code development container

  • HACS ready

  • Continuous integration with GitHub Actions

You can find a repository created with this cookiecutter template in the cookiecutter-homeassistant-custom-component-instance example.

FAQ

What is this project about?

The mission of this project is to provide Home Assistant custom component developers a ready-to-use template with best practices from Home Assistant developers documentation and from Hypermodern Python blog articles.