From 956f759e73588dfaf31532f90c51ef89707d818b Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Thu, 13 Jul 2023 08:50:24 +0100 Subject: [PATCH] add Logging section to README. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 938bcfd..c7b991e 100644 --- a/README.md +++ b/README.md @@ -506,11 +506,25 @@ Returns a `VbanRtPacket`. Designed to be used internally by the interface but av States not guaranteed to be current (requires use of dirty parameters to confirm). -### `Errors` +## `Errors` - `errors.VBANCMDError`: Exception raised when general errors occur. - `errors.VBANCMDConnectionError`: Exception raised when connection/timeout errors occur. +## Logging + +It's possible to see the messages sent by the interface's setters and getters, may be useful for debugging. + +example: +```python +import voicemeeterlib + +logging.basicConfig(level=logging.DEBUG) + +with voicemeeterlib.api("banana") as vm: + ... +``` + ### `Tests` First make sure you installed the [development dependencies](https://github.com/onyx-and-iris/vban-cmd-python#installation)