onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2024-11-15 17:10:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

add Logging section to README.

Browse Source
This commit is contained in:
onyx-and-iris 2023-07-13 08:50:24 +01:00
parent dab519be9f
commit 956f759e73
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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)