jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-04 07:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document loggers manifest field (#1334)

Browse Source
This commit is contained in:
J. Nick Koston 2022-05-17 13:23:54 -05:00 committed by GitHub
parent ab9f007804
commit 59df487ca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/creating_integration_manifest.md
View File

@ -17,6 +17,7 @@ Every integration has a manifest file to specify basic information about an inte
"requirements": ["aiohue==1.9.1"], "requirements": ["aiohue==1.9.1"],
"quality_scale": "platinum", "quality_scale": "platinum",
"iot_class": "local_polling" "iot_class": "local_polling"
"loggers": ["aiohue"]
} }
``` ```
@ -95,6 +96,10 @@ Requirements are Python libraries or modules that you would normally install usi
Requirements is an array of strings. Each entry is a `pip` compatible string. For example, the media player Cast platform depends on the Python package PyChromecast v3.2.0: `["pychromecast==3.2.0"]`. Requirements is an array of strings. Each entry is a `pip` compatible string. For example, the media player Cast platform depends on the Python package PyChromecast v3.2.0: `["pychromecast==3.2.0"]`.
## Loggers
The `loggers` field is a list of names that the integration's requirements use for their [getLogger](https://docs.python.org/3/library/logging.html?highlight=logging#logging.getLogger) calls.
### Custom requirements during development & testing ### Custom requirements during development & testing
During the development of a component, it can be useful to test against different versions of a requirement. This can be done in two steps, using `pychromecast` as an example: During the development of a component, it can be useful to test against different versions of a requirement. This can be done in two steps, using `pychromecast` as an example: