Start your Home Assistant Custom Integration for Home Assistant Community Store (HACS) from a brand new test-ready and publish-ready project structure
This repository template is just a VSCode devcontainer which gonna deploy a cookiecutter template based on the integration_blueprint bootstrap and inspired by cookiecutter-homeassistant-custom-component.
This template is a devcontainer for VS Code. Be sure to know how those things work...
- At the top right of this repository page, select the green button "Use this template" to create your new own custom integration repository (see Github repository template doc)
- Clone your newly created repository in VS Code (see the see the VSCode docs)
- Reopen it in provided devcontainer (a popup should show up)
- Answer to prompts when asked
- Let the magic happen! ✨ ✨ ✨
Warning
All files outside of the .devcontainer might be overwritten by the template (including this README) The default licence ifrom the template is MIT, consider updating the LICENSE file if you want a different licence
Every integration_blueprint features are here (Github Workflows, default structure, python environment and test home assistant instance), some of cookiecutter-homeassistant-custom-component also, and a bit more...
- Start from a brand new test-ready and production-ready folder structure
- Auto retrieval of github repository URL, project name and owner
- VSCode tasks to Run Home Assistant instance and Lint code
- Pre-filled class names
- README draft with HACS button link to my.home-assistant.io
For more infos and roadmap, please check the template repository
- Add versionning and release scripts
- Add test suite
You juste need to keep the HACS button on the README file to allow users adding your custom integration repository to HACS.
Please refer to the HACS publish page to match the required specifications before publish (basically, you just have to handle the (https://github.com/home-assistant/brands) part)...