A good template to use as a reference is blueprint.

Requirements

For a integration repository to be valid these are the requirements:

Repository structure

• There is only one integration (one directory under ROOT_OF_THE_REPO/custom_components/) per repository (if you have more, only the first one will be managed).
• The integration (all the Python files for it) are located under ROOT_OF_THE_REPO/custom_components/INTEGRATION_NAME/.

OK example:

custom_components/awesome/__init_.py

custom_components/awesome/sensor.py

custom_components/awesome/manifest.json

info.md

README.md

Not OK example (1):

awesome/__init_.py

awesome/sensor.py

awesome/manifest.json

info.md

README.md

Not OK example (2):

__init_.py

sensor.py

manifest.json

info.md

README.md

manifest.json

In the integration directory, there is a manifest.json file.

As a minimum that file contains:

• domain
• documentation
• issue_tracker
• codeowners
• name

GitHub releases (optional)

If there are releases

When installing/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version. The choices will be the last 5 releases and the default branch.

If there are no releases

It will scan files in the branch marked as default.

Additional requirements for integrations

• If you have python requirements, you have added your integration to home-assistant/wheels-custom-integrations, this will make installation faster for your users.
• You have added your integration to home-assistant/brands, this will make your integration look good in the UI.