Skip to content

oncleben31/cookiecutter-homeassistant-custom-component

Repository files navigation

cookiecutter-homeassistant-custom-component

This repository is a Cookiecutter template for a Home Assistant custom component based on the integration_blueprint template.

This project is sort of fusion of cookiecutter-homeassistant-component, integration_blueprint and cookiecutter-hypermodern-python projects.

✨📚✨ Read the full documentation

Usage

It is recommended to use the latest stable version by using the command:

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

Features

  • Ready to use Home Assistant custom component
  • UI configuration with config Flow
  • Translations
  • Development, testing and step by step debugging in Visual Studio Code development container
  • HACS ready
  • Continuous integration with GitHub Actions
  • Settings for pre-commit
  • Optional tests suite with pytest and code coverage

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