{"id":13585966,"url":"https://github.com/ludeeus/integration_blueprint","last_synced_at":"2025-05-15T10:06:23.623Z","repository":{"id":39638421,"uuid":"174175978","full_name":"ludeeus/integration_blueprint","owner":"ludeeus","description":"Blueprint for custom_component developers.","archived":false,"fork":false,"pushed_at":"2025-05-12T05:39:23.000Z","size":441,"stargazers_count":458,"open_issues_count":0,"forks_count":190,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-05-12T06:34:37.638Z","etag":null,"topics":["blueprint","custom-component","home-assistant","homeassistant","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ludeeus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-03-06T16:00:21.000Z","updated_at":"2025-05-12T05:39:27.000Z","dependencies_parsed_at":"2024-06-08T19:46:39.958Z","dependency_job_id":"09c684ef-583c-4cec-9552-28fd885780fd","html_url":"https://github.com/ludeeus/integration_blueprint","commit_stats":{"total_commits":194,"total_committers":26,"mean_commits":7.461538461538462,"dds":0.5360824742268041,"last_synced_commit":"efc7cdefc0c9b5c6af43a4eda50ee7b62afa6248"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Fintegration_blueprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Fintegration_blueprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Fintegration_blueprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Fintegration_blueprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ludeeus","download_url":"https://codeload.github.com/ludeeus/integration_blueprint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319718,"owners_count":22051072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blueprint","custom-component","home-assistant","homeassistant","python"],"created_at":"2024-08-01T15:05:15.030Z","updated_at":"2025-05-15T10:06:23.595Z","avatar_url":"https://github.com/ludeeus.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Notice\r\n\r\nThe component and platforms in this repository are not meant to be used by a\r\nuser, but as a \"blueprint\" that custom component developers can build\r\nupon, to make more awesome stuff.\r\n\r\nHAVE FUN! 😎\r\n\r\n## Why?\r\n\r\nThis is simple, by having custom_components look (README + structure) the same\r\nit is easier for developers to help each other and for users to start using them.\r\n\r\nIf you are a developer and you want to add things to this \"blueprint\" that you think more\r\ndevelopers will have use for, please open a PR to add it :)\r\n\r\n## What?\r\n\r\nThis repository contains multiple files, here is a overview:\r\n\r\nFile | Purpose | Documentation\r\n-- | -- | --\r\n`.devcontainer.json` | Used for development/testing with Visual Studio Code. | [Documentation](https://code.visualstudio.com/docs/remote/containers)\r\n`.github/ISSUE_TEMPLATE/*.yml` | Templates for the issue tracker | [Documentation](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository)\r\n`custom_components/integration_blueprint/*` | Integration files, this is where everything happens. | [Documentation](https://developers.home-assistant.io/docs/creating_component_index)\r\n`CONTRIBUTING.md` | Guidelines on how to contribute. | [Documentation](https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors)\r\n`LICENSE` | The license file for the project. | [Documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository)\r\n`README.md` | The file you are reading now, should contain info about the integration, installation and configuration instructions. | [Documentation](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax)\r\n`requirements.txt` | Python packages used for development/lint/testing this integration. | [Documentation](https://pip.pypa.io/en/stable/user_guide/#requirements-files)\r\n\r\n## How?\r\n\r\n1. Create a new repository in GitHub, using this repository as a template by clicking the \"Use this template\" button in the GitHub UI.\r\n1. Open your new repository in Visual Studio Code devcontainer (Preferably with the \"`Dev Containers: Clone Repository in Named Container Volume...`\" option).\r\n1. Rename all instances of the `integration_blueprint` to `custom_components/\u003cyour_integration_domain\u003e` (e.g. `custom_components/awesome_integration`).\r\n1. Rename all instances of the `Integration Blueprint` to `\u003cYour Integration Name\u003e` (e.g. `Awesome Integration`).\r\n1. Run the `scripts/develop` to start HA and test out your new integration.\r\n\r\n## Next steps\r\n\r\nThese are some next steps you may want to look into:\r\n- Add tests to your integration, [`pytest-homeassistant-custom-component`](https://github.com/MatthewFlamm/pytest-homeassistant-custom-component) can help you get started.\r\n- Add brand images (logo/icon) to https://github.com/home-assistant/brands.\r\n- Create your first release.\r\n- Share your integration on the [Home Assistant Forum](https://community.home-assistant.io/).\r\n- Submit your integration to [HACS](https://hacs.xyz/docs/publish/start).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludeeus%2Fintegration_blueprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fludeeus%2Fintegration_blueprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludeeus%2Fintegration_blueprint/lists"}