.gitignore

@@ -47,7 +47,4 @@ venv.bak/
 
 # Test/config
 quick.py
-config.toml
-obsws.log
-
-.vscode/
+config.toml

README.md

@@ -5,6 +5,7 @@
 
 # A Python SDK for OBS Studio WebSocket v5.0
 
+This is a wrapper around OBS Websocket.
 Not all endpoints in the official documentation are implemented.
 
 ## Requirements
@@ -12,7 +13,7 @@ Not all endpoints in the official documentation are implemented.
 -   [OBS Studio](https://obsproject.com/)
 -   [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
     -   With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS.
--   Python 3.9 or greater
+-   Python 3.10 or greater
 
 ### How to install using pip
 
@@ -26,8 +27,7 @@ By default the clients connect with parameters:
 
 -   `host`: "localhost"
 -   `port`: 4455
--   `password`: ""
--   `timeout`: None
+-   `password`: None
 
 You may override these parameters by storing them in a toml config file or passing them as keyword arguments.
 
@@ -44,7 +44,7 @@ port = 4455
 password = "mystrongpass"
 ```
 
-It should be placed in your user home directory.
+It should be placed next to your `__main__.py` file.
 
 #### Otherwise:
 
@@ -54,7 +54,7 @@ Example `__main__.py`:
 import obsws_python as obs
 
 # pass conn info if not in config.toml
-cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass', timeout=3)
+cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass')
 
 # Toggle the mute state of your Mic input
 cl.toggle_input_mute('Mic/Aux')
@@ -132,8 +132,6 @@ If a request fails an `OBSSDKError` will be raised with a status code.
 
 For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 
-If a timeout occurs during sending/receiving a request or receiving an event an `OBSSDKTimeoutError` will be raised.
-
 ### Logging
 
 If you want to see the raw messages simply set log level to DEBUG

examples/events/README.md

@@ -6,7 +6,7 @@ Registers a list of callback functions to hook into OBS events.
 
 Simply run the code and trigger the events, press `<Enter>` to exit.
 
-This example assumes the existence of a `config.toml`, placed in your user home directory:
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
 
 ```toml
 [connection]

examples/hotkeys/README.md

@@ -8,7 +8,7 @@ Requires [Python Keyboard library](https://github.com/boppreh/keyboard).
 
 Simply run the code and press the assigned hotkeys. Press `ctrl+enter` to exit.
 
-This example assumes the existence of a `config.toml`, placed in your user home directory:
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
 
 ```toml
 [connection]

examples/levels/README.md

@@ -4,7 +4,7 @@ Prints POSTFADER level values for audio device `Desktop Audio`. If mute toggled
 
 ## Use
 
-This example assumes the existence of a `config.toml`, placed in your user home directory:
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
 
 ```toml
 [connection]

examples/scene_rotate/README.md

@@ -4,7 +4,7 @@ Collects the names of all available scenes, rotates through them and prints thei
 
 ## Use
 
-This example assumes the existence of a `config.toml`, placed in your user home directory:
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
 
 ```toml
 [connection]

obsws_python/__init__.py

@@ -1,6 +1,6 @@
+from .enum import Subs
 from .events import EventClient
 from .reqs import ReqClient
-from .subs import Subs
 from .version import version as __version__
 
 __ALL__ = ["ReqClient", "EventClient", "Subs"]

obsws_python/baseclient.py

@@ -4,25 +4,22 @@ import json
 import logging
 from pathlib import Path
 from random import randint
-from typing import Optional
+
+try:
+    import tomllib
+except ModuleNotFoundError:
+    import tomli as tomllib
 
 import websocket
-from websocket import WebSocketTimeoutException
 
-from .error import OBSSDKError, OBSSDKTimeoutError
+from .error import OBSSDKError
 
 
 class ObsClient:
     logger = logging.getLogger("baseclient.obsclient")
 
     def __init__(self, **kwargs):
-        defaultkwargs = {
-            "host": "localhost",
-            "port": 4455,
-            "password": "",
-            "subs": 0,
-            "timeout": None,
-        }
+        defaultkwargs = {"host": "localhost", "port": 4455, "password": None, "subs": 0}
         if not any(key in kwargs for key in ("host", "port", "password")):
             kwargs |= self._conn_from_toml()
         kwargs = defaultkwargs | kwargs
@@ -30,47 +27,21 @@ class ObsClient:
             setattr(self, attr, val)
 
         self.logger.info(
-            "Connecting with parameters: host='{host}' port={port} password='{password}' subs={subs} timeout={timeout}".format(
+            "Connecting with parameters: {host} {port} {password} {subs}".format(
                 **self.__dict__
             )
         )
 
-        try:
-            self.ws = websocket.WebSocket()
-            self.ws.connect(f"ws://{self.host}:{self.port}", timeout=self.timeout)
-            self.server_hello = json.loads(self.ws.recv())
-        except ValueError as e:
-            self.logger.error(f"{type(e).__name__}: {e}")
-            raise
-        except (ConnectionRefusedError, WebSocketTimeoutException) as e:
-            self.logger.exception(f"{type(e).__name__}: {e}")
-            raise
+        self.ws = websocket.WebSocket()
+        self.ws.connect(f"ws://{self.host}:{self.port}")
+        self.server_hello = json.loads(self.ws.recv())
 
     def _conn_from_toml(self) -> dict:
-        try:
-            import tomllib
-        except ModuleNotFoundError:
-            import tomli as tomllib
-
-        def get_filepath() -> Optional[Path]:
-            """
-            traverses a list of paths for a 'config.toml'
-            returns the first config file found or None.
-            """
-            filepaths = [
-                Path.cwd() / "config.toml",
-                Path.home() / "config.toml",
-                Path.home() / ".config" / "obsws-python" / "config.toml",
-            ]
-            for filepath in filepaths:
-                if filepath.exists():
-                    return filepath
-
         conn = {}
-        if filepath := get_filepath():
+        filepath = Path.cwd() / "config.toml"
+        if filepath.exists():
             with open(filepath, "rb") as f:
                 conn = tomllib.load(f)
-            self.logger.info(f"loading config from {filepath}")
         return conn["connection"] if "connection" in conn else conn
 
     def authenticate(self):
@@ -119,11 +90,7 @@ class ObsClient:
         if req_data:
             payload["d"]["requestData"] = req_data
         self.logger.debug(f"Sending request {payload}")
-        try:
-            self.ws.send(json.dumps(payload))
-            response = json.loads(self.ws.recv())
-        except WebSocketTimeoutException as e:
-            self.logger.exception(f"{type(e).__name__}: {e}")
-            raise OBSSDKTimeoutError("Timeout while trying to send the request") from e
+        self.ws.send(json.dumps(payload))
+        response = json.loads(self.ws.recv())
         self.logger.debug(f"Response received {response}")
         return response["d"]

obsws_python/error.py

@@ -1,6 +1,4 @@
 class OBSSDKError(Exception):
-    """Exception raised when general errors occur"""
+    """general errors"""
 
-
-class OBSSDKTimeoutError(Exception):
-    """Exception raised when a connection times out"""
+    pass

obsws_python/events.py

@@ -3,12 +3,9 @@ import logging
 import time
 from threading import Thread
 
-from websocket import WebSocketTimeoutException
-
 from .baseclient import ObsClient
 from .callback import Callback
-from .error import OBSSDKTimeoutError
-from .subs import Subs
+from .enum import Subs
 
 """
 A class to interact with obs-websocket events
@@ -31,13 +28,6 @@ class EventClient:
         self.subscribe()
 
     def __repr__(self):
-        return type(
-            self
-        ).__name__ + "(host='{host}', port={port}, password='{password}', subs={subs}, timeout={timeout})".format(
-            **self.base_client.__dict__,
-        )
-
-    def __str__(self):
         return type(self).__name__
 
     def subscribe(self):
@@ -52,11 +42,7 @@ class EventClient:
         """
         self.running = True
         while self.running:
-            try:
-                event = json.loads(self.base_client.ws.recv())
-            except WebSocketTimeoutException as e:
-                self.logger.exception(f"{type(e).__name__}: {e}")
-                raise OBSSDKTimeoutError("Timeout while waiting for event") from e
+            event = json.loads(self.base_client.ws.recv())
             self.logger.debug(f"Event received {event}")
             type_, data = (
                 event["d"].get("eventType"),

obsws_python/reqs.py

@@ -26,16 +26,9 @@ class ReqClient:
         self.base_client.ws.close()
 
     def __repr__(self):
-        return type(
-            self
-        ).__name__ + "(host='{host}', port={port}, password='{password}', timeout={timeout})".format(
-            **self.base_client.__dict__,
-        )
-
-    def __str__(self):
         return type(self).__name__
 
-    def send(self, param, data=None, raw=False):
+    def send(self, param, data=None):
         response = self.base_client.req(param, data)
         if not response["requestStatus"]["result"]:
             error = (
@@ -45,8 +38,6 @@ class ReqClient:
                 error += (f"With message: {response['requestStatus']['comment']}",)
             raise OBSSDKError("\n".join(error))
         if "responseData" in response:
-            if raw:
-                return response["responseData"]
             return as_dataclass(response["requestType"], response["responseData"])
 
     def get_version(self):
@@ -1494,7 +1485,7 @@ class ReqClient:
         payload = {
             "sceneName": scene_name,
             "sceneItemId": item_id,
-            "sceneItemIndex": item_index,
+            "sceneItemLocked": item_index,
         }
         self.send("SetSceneItemIndex", payload)
 
@@ -1738,10 +1729,7 @@ class ReqClient:
 
 
         """
-        payload = {
-            "captionText": caption,
-        }
-        self.send("SendStreamCaption", payload)
+        self.send("SendStreamCaption")
 
     def get_record_status(self):
         """

obsws_python/version.py

@@ -1 +1 @@
-version = "1.5.0"
+version = "1.3.0"

pyproject.toml

@@ -8,7 +8,7 @@ dynamic = ["version"]
 description = "A Python SDK for OBS Studio WebSocket v5.0"
 readme = "README.md"
 license = "GPL-3.0-only"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 authors = [
     { name = "Adem Atikturk", email = "aatikturk@gmail.com" },
 ]
@@ -37,18 +37,7 @@ include = [
 ]
 
 [tool.hatch.envs.e.scripts]
-events = "python {root}\\examples\\events\\."
-hotkeys = "python {root}\\examples\\hotkeys\\."
-levels = "python {root}\\examples\\levels\\."
-scene_rotate = "python {root}\\examples\\scene_rotate\\."
-
-[tool.hatch.envs.test]
-dependencies = [
-  "pytest",
-]
-
-[tool.hatch.envs.test.scripts]
-run = 'pytest -v'
-
-[[tool.hatch.envs.test.matrix]]
-python = ["39", "310", "311"]
+events = "py {root}\\examples\\events\\."
+hotkeys = "py {root}\\examples\\hotkeys\\."
+levels = "py {root}\\examples\\levels\\."
+scene_rotate = "py {root}\\examples\\scene_rotate\\."

setup.py

@@ -40,7 +40,7 @@ EXTRAS_REQUIRE = {
 }
 
 # Python version requirement
-PYTHON_REQUIRES = ">=3.9"
+PYTHON_REQUIRES = ">=3.10"
 
 setup(
     name=PACKAGE_NAME,

tests/__init__.py

@@ -13,7 +13,4 @@ def teardown_module():
     req_cl.remove_scene("START_TEST")
     req_cl.remove_scene("BRB_TEST")
     req_cl.remove_scene("END_TEST")
-    resp = req_cl.get_studio_mode_enabled()
-    if resp.studio_mode_enabled:
-        req_cl.set_studio_mode_enabled(False)
     req_cl.base_client.ws.close()