cookiecutter-homeassistant-component
A cookiecutter template for generating a new homeassistant custom component.
Features
- Generates the appropriate file structure for a minimal homeassistant custom component.
- Generates metadata to allow submission to HACS.
- Contains everything needed to get started with writing unit tests for your custom component.
- Contains an optional pre-commit config that mimics what the homeassistant core uses to help make your code compliant in case you want to eventually add it to the core codebase.
Installation
To get started you will need to install cookiecutter.
$ pip install cookiecutterThen generate your custom component:
$ cookiecutter https://github.com/boralyl/cookiecutter-homeassistant-componentContext Options
You will be asked to provide the following values to configure your component:
| Field | Default | Description |
|---|---|---|
| domain | my_component | The domain name of your custom component. |
| name | My Component | The human readable name of your component. |
| docs_url | https://github.com/user/my_component/ | The URL pointing to documentation for your component. |
| owner | @user | Your github username prefixed with @. |
| config_flow | yes | Signifies if your component will support configuring via the UI via config flow. |
| iot_class | assumed_state | The Internet of Things classification for your component. Read more in the Home Assistant documentation. |
| version | 1.0.0 | The version number for your custom component. Read more in the Home Assistant documentation. |
Pre-Commit
After your project is created a .pre-commit-config.yaml file is created in the root of your project.
This is completely optional, but will help you to conform you code to the homeassistant standards. The
configuration matches that used by homeassistant/core.
To start using it first install pre-commit, then initialize it.
$ pip install pre-commit
$ pre-commit install
pre-commit installed at .git/hooks/pre-commitThis will cause pre-commit checks to be run prior to every commit. Any failed checks will prevent you from pushing your code.
$ git commit -a
pyupgrade................................................................Passed
black....................................................................Passed
codespell................................................................Passed
flake8...................................................................Passed
bandit...................................................................Passed
isort....................................................................Passed
Check JSON...........................................(no files to check)Skipped
mypy.....................................................................PassedTesting
After generating your project you can install the test requirements using pip:
$ pip install -r requirements.test.txtOnce the test requirements are installed you can run the test suite. A simple working test is provided out of the box.
$ pytest
Test session starts (platform: linux, Python 3.7.5, pytest 5.4.2, pytest-sugar 0.9.3)
rootdir: /home/aaron/projects/my-component, inifile: setup.cfg, testpaths: tests
plugins: aiohttp-0.3.0, requests-mock-1.8.0, timeout-1.3.4, sugar-0.9.3, cov-2.8.1, homeassistant-0.1.0
collecting ...
tests/test_init.py ✓ 100% ██████████
----------- coverage: platform linux, python 3.7.5-final-0 -----------
Name Stmts Miss Cover Missing
--------------------------------------------------------------------------
custom_components/__init__.py 0 0 100%
custom_components/my_component/__init__.py 3 0 100%
custom_components/my_component/const.py 1 0 100%
--------------------------------------------------------------------------
TOTAL 4 0 100%
Results (0.07s):
1 passed