update examples to work with modified req client

examples now expect env variables

.gitignore

@@ -1,8 +1,14 @@
+# Generated by ignr: github.com/onyx-and-iris/ignr
+
+## Python ##
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[cod]
+*.py[codz]
 *$py.class
 
+# C extensions
+*.so
+
 # Distribution / packaging
 .Python
 build/
@@ -17,11 +23,22 @@ parts/
 sdist/
 var/
 wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
 
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -32,27 +49,169 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
+*.py.cover
 .hypothesis/
 .pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
 
 # Environments
 .env
+.envrc
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
-.hatch
 
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-.python-version
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# End of ignr
+
+tools/
 
-# Test/config
 test-*.py
-config.toml
-obsws.log
-
-.vscode/
+config.toml

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

examples/events/__main__.py

@@ -1,11 +1,13 @@
-import time
+import os
+from threading import Event
 
 import obsws_python as obs
 
 
 class Observer:
-    def __init__(self):
-        self._client = obs.EventClient()
+    def __init__(self, host, port, password, stop_event):
+        self._client = obs.EventClient(host=host, port=port, password=password)
+        self._stop_event = stop_event
         self._client.callback.register(
             [
                 self.on_current_program_scene_changed,
@@ -15,7 +17,6 @@ class Observer:
             ]
         )
         print(f"Registered events: {self._client.callback.get()}")
-        self.running = True
 
     def __enter__(self):
         return self
@@ -38,10 +39,15 @@ class Observer:
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
         print("OBS closing!")
-        self.running = False
+        self._stop_event.set()
 
 
 if __name__ == "__main__":
-    with Observer() as observer:
-        while observer.running:
-            time.sleep(0.1)
+    host = os.getenv("OBSWS_HOST", "localhost")
+    port = int(os.getenv("OBSWS_PORT", 4455))
+    password = os.getenv("OBSWS_PASSWORD", "")
+
+    stop_event = Event()
+
+    with Observer(host, port, password, stop_event) as observer:
+        stop_event.wait()

examples/hotkeys/__main__.py

@@ -1,13 +1,14 @@
 import inspect
+import os
 
-import keyboard
+import keyboard  # type: ignore
 
 import obsws_python as obs
 
 
 class Observer:
-    def __init__(self):
-        self._client = obs.EventClient()
+    def __init__(self, host, port, password):
+        self._client = obs.EventClient(host=host, port=port, password=password)
         self._client.callback.register(self.on_current_program_scene_changed)
         print(f"Registered events: {self._client.callback.get()}")
 
@@ -34,12 +35,16 @@ def version():
 
 
 def set_scene(scene, *args):
-    req_client.set_current_program_scene(scene)
+    req_client.set_current_program_scene(scene_name=scene)
 
 
 if __name__ == "__main__":
-    with obs.ReqClient() as req_client:
-        with Observer() as observer:
+    host = os.getenv("OBSWS_HOST", "localhost")
+    port = int(os.getenv("OBSWS_PORT", 4455))
+    password = os.getenv("OBSWS_PASSWORD", "")
+
+    with obs.ReqClient(host=host, port=port, password=password) as req_client:
+        with Observer(host, port, password) as observer:
             keyboard.add_hotkey("0", version)
             keyboard.add_hotkey("1", set_scene, args=("START",))
             keyboard.add_hotkey("2", set_scene, args=("BRB",))

examples/levels/__main__.py

@@ -1,3 +1,4 @@
+import os
 from enum import IntEnum
 from math import log
 
@@ -34,8 +35,15 @@ def on_input_volume_meters(data):
 
 
 def main():
+    host = os.getenv("OBSWS_HOST", "localhost")
+    port = int(os.getenv("OBSWS_PORT", 4455))
+    password = os.getenv("OBSWS_PASSWORD", "")
+
     with obs.EventClient(
-        subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS)
+        host=host,
+        port=port,
+        password=password,
+        subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS),
     ) as client:
         client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
 

examples/scene_rotate/__main__.py

@@ -1,16 +1,21 @@
+import os
 import time
 
 import obsws_python as obs
 
 
 def main():
-    with obs.ReqClient() as client:
+    host = os.getenv("OBSWS_HOST", "localhost")
+    port = int(os.getenv("OBSWS_PORT", 4455))
+    password = os.getenv("OBSWS_PASSWORD", "")
+
+    with obs.ReqClient(host=host, port=port, password=password) as client:
         resp = client.get_scene_list()
         scenes = [di.get("sceneName") for di in reversed(resp.scenes)]
 
         for scene in scenes:
             print(f"Switching to scene {scene}")
-            client.set_current_program_scene(scene)
+            client.set_current_program_scene(scene_name=scene)
             time.sleep(0.5)
 
 

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,24 +19,35 @@ 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.env.collectors.dotenv.e]
+env-files = [".env"]
+fail-on-missing = true
+
+[tool.hatch.env.collectors.dotenv.hatch-test]
+env-files = [".env"]
+fail-on-missing = true
 
 [tool.hatch.envs.default]
 dependencies = ["pre-commit"]
 
 [tool.hatch.envs.e]
 dependencies = ["keyboard"]
+env-include = ["OBSWS_*"]
 
 [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\\."
+events = "python -m examples.events"
+hotkeys = "python -m examples.hotkeys"
+levels = "python -m examples.levels"
+scene-rotate = "python -m examples.scene_rotate"
 
 [tool.hatch.envs.hatch-test]
 randomize = true
+env-include = ["OBSWS_*"]
 
 [tool.hatch.envs.hatch-test.scripts]
 run = "pytest{env:HATCH_TEST_ARGS:} {args}"
@@ -51,20 +57,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 +79,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_HOST", "localhost"),
+    port=int(os.getenv("OBSWS_PORT", 4455)),
+    password=os.getenv("OBSWS_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_HOST", "localhost"),
+            "port": int(os.getenv("OBSWS_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_HOST", "localhost"),
+            "port": int(os.getenv("OBSWS_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