From 78f9fc7f532ca93fa9fdeed9ad5020cf2188cb68 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Wed, 1 Apr 2026 12:28:05 +0100 Subject: [PATCH] add entry point docstring --- streamlabsio/client.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/streamlabsio/client.py b/streamlabsio/client.py index 93b326c..271cf83 100644 --- a/streamlabsio/client.py +++ b/streamlabsio/client.py @@ -94,4 +94,13 @@ class Client: def request_client_object(*, token: str, raw: bool = False) -> Client: + """Entry point for users to request a Client object. + + Args: + token (str): The authentication token for the Streamlabs Socket API. + raw (bool, optional): If True, the client will return raw event data. Defaults to False. + + Returns: + Client: An instance of the Client class. + """ return Client(token=token, raw=raw)