From 59df487ca1beaa5e4979b028aababb94cd4473e9 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Tue, 17 May 2022 13:23:54 -0500 Subject: [PATCH] Document `loggers` manifest field (#1334) --- docs/creating_integration_manifest.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/creating_integration_manifest.md b/docs/creating_integration_manifest.md index ce1e0528..1204d081 100644 --- a/docs/creating_integration_manifest.md +++ b/docs/creating_integration_manifest.md @@ -17,6 +17,7 @@ Every integration has a manifest file to specify basic information about an inte "requirements": ["aiohue==1.9.1"], "quality_scale": "platinum", "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"]`. +## 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 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: