Awesome

Notice

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! 😎

Why?

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 :)

What?

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

How?

Create a new repository in GitHub, using this repository as a template by clicking the "Use this template" button in the GitHub UI.
Open your new repository in Visual Studio Code devcontainer (Preferably with the "Dev Containers: Clone Repository in Named Container Volume..." option).
Rename all instances of the integration_blueprint to custom_components/<your_integration_domain> (e.g. custom_components/awesome_integration).
Rename all instances of the Integration Blueprint to <Your Integration Name> (e.g. Awesome Integration).
Run the scripts/develop to start HA and test out your new integration.

Next steps

These are some next steps you may want to look into:

Add tests to your integration, pytest-homeassistant-custom-component can help you get started.
Add brand images (logo/icon) to https://github.com/home-assistant/brands.
Create your first release.
Share your integration on the Home Assistant Forum.
Submit your integration to HACS.