ludeeus/integration_blueprint

Stars
324
Rank 129,708 (Top 3 %)
Language
Python
License
MIT License
Created over 5 years ago
Updated 10 months ago

ludeeus/integration_blueprint

ludeeus

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Blueprint for custom_component developers.

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 the HACS.

action-shellcheck

GitHub action for ShellCheck.

awesomeversion

One version package to rule them all, One version package to find them, One version package to bring them all, and in the darkness bind them.

action-ha-config-check

Check Home Assistant Configuration

aiogithubapi

Asynchronous Python client for the GitHub API

container

Custom containers for various usecases

googledevices

Get information from, and control various Google devices.

pytraccar

Update and fetch device information from Traccar.

setup-homeassistant

Setup a Home Assistant instance in your GitHub action flow.

custom-component-store

📦 Manage your custom_components for Home Assistant

action-push

Push the updated workspace back to the repository.

dockerfile-updater

A GitHub action to handle your Dockerfile dependencies.

alpinepkgs

Python package that give you information about packages from pkgs.alpinelinux.org

pyhaversion

Get the latest Home Assistant version from various sources.

action-accesscontrol

Check if the invoker has access defined access level.

pycfdns

Update Cloudflare DNS records.

hachanges

Easy list breaking changes for Home Assistant

home-assistant-configuration

This repository exists mostly for my own amusement, but it may contain some things that others might find useful.

customjson

Creates json with information for custom_updater and custom_component_store.

ad-watchdog

Watchdog App for AppDaemon.

pyuptimerobot

Python API wrapper for Uptime Robot

reporeleaser

Create a new release for your repo, with a commit changelog.

ad-address

This appends address information attributes based on the lat/long from a device tracker entity.

addonupdater

Update dependencies in Community add-ons.

pylaunches

A python packages to get information form upcoming space launches,

pytautulli

A python module to get information from Tautulli

awesome-addons-repository

My awesome add-ons repository

pyaftership

Async Python wrapper for the AfterShip API

action-eventdata

Display the content of the event that triggered the run.

actions

Testground for GitHub Actions

furystoolbox

A collection of tools.

pyupdate

action-reporeleaser

Create a new release using reporeleaser.

theme-hacs

Sample theme repository for HACS.

webhook

V powered CLI Webhook notifier

ad-hacs

Sample AppDaemon app for HACS.

pyhassbian

A python package to interact with hassbian-config.

integration-hacs

Sample integration repository for HACS.

sampleclient

Sample Client lib.

hacs-actions

pyruter

A module to get information about the next departure from a stop.

colorlog

A simple component to format log output with colors.

nothing

Custom integration for Home Assistant that do nothing

action-require-labels

This action privides a simple solution to require specific labels on pull requests. Without the need to use the GitHub API and tokens.