add autogenerated reqclient methods

update tests so they pass

add Taskfile

add hatch-dotenv plugin

.gitignore

@@ -55,4 +55,5 @@ test-*.py
 config.toml
 obsws.log
 
-.vscode/
+.vscode/
+tools/

Taskfile.yaml

@@ -0,0 +1,23 @@
+version: '3'
+
+tasks:
+  default:
+    desc: Generate ReqClient methods from the API spec
+    deps: [generate]
+
+  generate:
+    desc: Generate ReqClient methods from the API spec
+    deps: [pull-protocol-json]
+    cmds:
+      - python tools/generate.py
+      - hatch run style:fmt
+    internal: true
+
+  pull-protocol-json:
+    desc: Pull the latest API spec from the obs-websocket repository
+    preconditions:
+      - sh: '[ ! -f tools/protocol.json ] || [ "$(find tools/protocol.json -mmin +1440)" ]'
+        msg: 'The protocol.json file is up to date (last modified less than 24 hours ago).'
+    cmds:
+      - curl -sSfL -o tools/protocol.json "https://raw.githubusercontent.com/obsproject/obs-websocket/refs/heads/master/docs/generated/protocol.json"
+    internal: true

pyproject.toml

@@ -9,13 +9,8 @@ description = "A Python SDK for OBS Studio WebSocket v5.0"
 readme = "README.md"
 license = { text = "GPL-3.0-only" }
 requires-python = ">=3.9"
-authors = [
-    { name = "Adem Atikturk", email = "aatikturk@gmail.com" },
-]
-dependencies = [
-    "tomli >= 2.0.1;python_version < '3.11'",
-    "websocket-client",
-]
+authors = [{ name = "Adem Atikturk", email = "aatikturk@gmail.com" }]
+dependencies = ["tomli >= 2.0.1;python_version < '3.11'", "websocket-client"]
 
 [project.urls]
 Homepage = "https://github.com/aatikturk/obsws-python"
@@ -24,9 +19,10 @@ Homepage = "https://github.com/aatikturk/obsws-python"
 path = "obsws_python/version.py"
 
 [tool.hatch.build.targets.sdist]
-include = [
-    "/obsws_python",
-]
+include = ["/obsws_python"]
+
+[tool.hatch.env]
+requires = ["hatch-dotenv"]
 
 [tool.hatch.envs.default]
 dependencies = ["pre-commit"]
@@ -42,6 +38,11 @@ scene_rotate = "python {root}\\examples\\scene_rotate\\."
 
 [tool.hatch.envs.hatch-test]
 randomize = true
+env-include = ["OBSWS_TEST_*"]
+
+[tool.hatch.env.collectors.dotenv.hatch-test]
+env-files = [".env"]
+fail-on-missing = true
 
 [tool.hatch.envs.hatch-test.scripts]
 run = "pytest{env:HATCH_TEST_ARGS:} {args}"
@@ -51,20 +52,11 @@ python = ["313", "312", "311", "310", "39"]
 
 [tool.hatch.envs.style]
 detached = true
-dependencies = [
-    "black",
-    "isort",
-]
+dependencies = ["black", "isort"]
 
 [tool.hatch.envs.style.scripts]
-check = [
-    "black --check --diff .",
-    "isort --check-only --diff .",
-]
-fmt = [
-    "isort .",
-    "black .",
-]
+check = ["black --check --diff .", "isort --check-only --diff ."]
+fmt = ["isort .", "black ."]
 
 [tool.black]
 line-length = 88
@@ -82,4 +74,4 @@ extend-exclude = '''
 [tool.isort]
 profile = "black"
 skip = [".gitignore", ".dockerignore"]
-skip_glob = [".git/*", ".hatch/*", ".pytest_cache/*"]
+skip_glob = [".git/*", ".hatch/*", ".pytest_cache/*"]

tests/__init__.py

@@ -1,19 +1,25 @@
+import os
+
 import obsws_python as obs
 
-req_cl = obs.ReqClient()
+req_cl = obs.ReqClient(
+    host=os.getenv("OBSWS_TEST_HOST", "localhost"),
+    port=int(os.getenv("OBSWS_TEST_PORT", 4455)),
+    password=os.getenv("OBSWS_TEST_PASSWORD", ""),
+)
 
 
 def setup_module():
-    req_cl.create_scene("START_TEST")
-    req_cl.create_scene("BRB_TEST")
-    req_cl.create_scene("END_TEST")
+    req_cl.create_scene(scene_name="START_TEST")
+    req_cl.create_scene(scene_name="BRB_TEST")
+    req_cl.create_scene(scene_name="END_TEST")
 
 
 def teardown_module():
-    req_cl.remove_scene("START_TEST")
-    req_cl.remove_scene("BRB_TEST")
-    req_cl.remove_scene("END_TEST")
+    req_cl.remove_scene(scene_name="START_TEST")
+    req_cl.remove_scene(scene_name="BRB_TEST")
+    req_cl.remove_scene(scene_name="END_TEST")
     resp = req_cl.get_studio_mode_enabled()
     if resp.studio_mode_enabled:
-        req_cl.set_studio_mode_enabled(False)
+        req_cl.set_studio_mode_enabled(studio_mode_enabled=False)
     req_cl.base_client.ws.close()

tests/test_error.py

@@ -1,3 +1,5 @@
+import os
+
 import pytest
 
 import obsws_python as obsws
@@ -8,7 +10,11 @@ class TestErrors:
     __test__ = True
 
     def test_it_raises_an_obssdk_error_on_incorrect_password(self):
-        bad_conn = {"host": "localhost", "port": 4455, "password": "incorrectpassword"}
+        bad_conn = {
+            "host": os.getenv("OBSWS_TEST_HOST", "localhost"),
+            "port": int(os.getenv("OBSWS_TEST_PORT", 4455)),
+            "password": "incorrectpassword",
+        }
         with pytest.raises(
             obsws.error.OBSSDKError,
             match="failed to identify client with the server, please check connection settings",
@@ -16,7 +22,11 @@ class TestErrors:
             obsws.ReqClient(**bad_conn)
 
     def test_it_raises_an_obssdk_error_if_auth_enabled_but_no_password_provided(self):
-        bad_conn = {"host": "localhost", "port": 4455, "password": ""}
+        bad_conn = {
+            "host": os.getenv("OBSWS_TEST_HOST", "localhost"),
+            "port": int(os.getenv("OBSWS_TEST_PORT", 4455)),
+            "password": "",
+        }
         with pytest.raises(
             obsws.error.OBSSDKError,
             match="authentication enabled but no password provided",
@@ -28,7 +38,7 @@ class TestErrors:
             obsws.error.OBSSDKRequestError,
             match="Request SetCurrentProgramScene returned code 600. With message: No source was found by the name of `invalid`.",
         ) as exc_info:
-            req_cl.set_current_program_scene("invalid")
+            req_cl.set_current_program_scene(scene_name="invalid")
 
         e = exc_info.value
         assert e.req_name == "SetCurrentProgramScene"

tests/test_request.py

@@ -11,8 +11,8 @@ class TestRequests:
         assert hasattr(resp, "obs_version")
         assert hasattr(resp, "obs_web_socket_version")
 
-    def test_get_hot_key_list(self):
-        resp = req_cl.get_hot_key_list()
+    def test_get_hotkey_list(self):
+        resp = req_cl.get_hotkey_list()
         assert resp.hotkeys
         assert any(x.startswith("OBSBasic.") for x in resp.hotkeys)
 
@@ -24,16 +24,20 @@ class TestRequests:
         ],
     )
     def test_persistent_data(self, name, data):
-        req_cl.set_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name, data)
-        resp = req_cl.get_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name)
+        req_cl.set_persistent_data(
+            realm="OBS_WEBSOCKET_DATA_REALM_PROFILE", slot_name=name, slot_value=data
+        )
+        resp = req_cl.get_persistent_data(
+            realm="OBS_WEBSOCKET_DATA_REALM_PROFILE", slot_name=name
+        )
         assert resp.slot_value == data
 
     @pytest.mark.skip(reason="possible bug in obs-websocket, needs checking")
     def test_profile_list(self):
-        req_cl.create_profile("test")
+        req_cl.create_profile(profile_name="test")
         resp = req_cl.get_profile_list()
         assert "test" in resp.profiles
-        req_cl.remove_profile("test")
+        req_cl.remove_profile(profile_name="test")
         resp = req_cl.get_profile_list()
         assert "test" not in resp.profiles
 
@@ -43,8 +47,8 @@ class TestRequests:
             "key": "live_myvery_secretkey",
         }
         req_cl.set_stream_service_settings(
-            "rtmp_common",
-            settings,
+            stream_service_type="rtmp_common",
+            stream_service_settings=settings,
         )
         resp = req_cl.get_stream_service_settings()
         assert resp.stream_service_type == "rtmp_common"
@@ -62,13 +66,17 @@ class TestRequests:
         ],
     )
     def test_current_program_scene(self, scene):
-        req_cl.set_current_program_scene(scene)
+        req_cl.set_current_program_scene(scene_name=scene)
         resp = req_cl.get_current_program_scene()
         assert resp.current_program_scene_name == scene
 
     def test_input_list(self):
         req_cl.create_input(
-            "START_TEST", "test", "color_source_v3", {"color": 4294945535}, True
+            scene_name="START_TEST",
+            input_name="test",
+            input_kind="color_source_v3",
+            input_settings={"color": 4294945535},
+            scene_item_enabled=True,
         )
         resp = req_cl.get_input_list()
         for input_item in resp.inputs:
@@ -80,14 +88,18 @@ class TestRequests:
             # This else block is executed if the for loop completes without finding the input_item with inputName "test"
             raise AssertionError("Input with inputName 'test' not found")
 
-        resp = req_cl.get_input_settings("test")
+        resp = req_cl.get_input_settings(input_name="test")
         assert resp.input_kind == "color_source_v3"
         assert resp.input_settings == {"color": 4294945535}
-        req_cl.remove_input("test")
+        req_cl.remove_input(input_name="test")
 
     def test_source_filter(self):
-        req_cl.create_source_filter("START_TEST", "test", "color_key_filter_v2")
-        resp = req_cl.get_source_filter_list("START_TEST")
+        req_cl.create_source_filter(
+            source_name="START_TEST",
+            filter_name="test",
+            filter_kind="color_key_filter_v2",
+        )
+        resp = req_cl.get_source_filter_list(source_name="START_TEST")
         assert resp.filters == [
             {
                 "filterEnabled": True,
@@ -97,7 +109,7 @@ class TestRequests:
                 "filterSettings": {},
             }
         ]
-        req_cl.remove_source_filter("START_TEST", "test")
+        req_cl.remove_source_filter(source_name="START_TEST", filter_name="test")
 
     @pytest.mark.parametrize(
         "state",
@@ -107,6 +119,6 @@ class TestRequests:
         ],
     )
     def test_studio_mode_enabled(self, state):
-        req_cl.set_studio_mode_enabled(state)
+        req_cl.set_studio_mode_enabled(studio_mode_enabled=state)
         resp = req_cl.get_studio_mode_enabled()
         assert resp.studio_mode_enabled == state