Blueprint for custom_component developers.
MIT License
The component and platforms in this repository are not meant to be used by a user, but as a "blueprint" that custom component developers can build upon, to make more awesome stuff.
HAVE FUN! 😎
This is simple, by having custom_components look (README + structure) the same it is easier for developers to help each other and for users to start using them.
If you are a developer and you want to add things to this "blueprint" that you think more developers will have use for, please open a PR to add it :)
This repository contains multiple files, here is a overview:
File | Purpose | Documentation |
---|---|---|
.devcontainer.json |
Used for development/testing with Visual Studio Code. | Documentation |
.github/ISSUE_TEMPLATE/*.yml |
Templates for the issue tracker | Documentation |
.vscode/tasks.json |
Tasks for the devcontainer. | Documentation |
custom_components/integration_blueprint/* |
Integration files, this is where everything happens. | Documentation |
CONTRIBUTING.md |
Guidelines on how to contribute. | Documentation |
LICENSE |
The license file for the project. | Documentation |
README.md |
The file you are reading now, should contain info about the integration, installation and configuration instructions. | Documentation |
requirements.txt |
Python packages used for development/lint/testing this integration. | Documentation |
Dev Containers: Clone Repository in Named Container Volume...
" option).integration_blueprint
to custom_components/<your_integration_domain>
(e.g. custom_components/awesome_integration
).Integration Blueprint
to <Your Integration Name>
(e.g. Awesome Integration
).scripts/develop
to start HA and test out your new integration.These are some next steps you may want to look into:
pytest-homeassistant-custom-component
can help you get started.