catch ConnectionRefusedError as well as TimeoutError

patch bump

README.md

@@ -28,7 +28,18 @@ pipx install simple-recorder
 
 *with pyz*
 
-An executable pyz has been included in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases) which you can run in Windows. Follow the steps in this [Setting up Windows for Zipapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps) guide.
+-   Download the pyz file in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases)
+-   Optional step: for automatic discovery of the pyz file follow this guide on [Setting Up Windows for Zippapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps)
+
+Finally run the pyz with python (CLI)/pythonw (GUI):
+
+```console
+python simple-recorder.pyz <subcommand>
+
+pythonw simple-recorder.pyz
+```
+
+note, the pyz extension won't be required if you followed the optional step and made it discoverable.
 
 ## Configuration
 
@@ -49,12 +60,44 @@ OBS_THEME=Reds
 
 ## Use
 
-### GUI
+### CLI
 
-To launch the GUI run the root command without any subcommands:
+To launch the CLI:
 
 ```console
-simple-recorder
+simple-recorder start "File Name"
+
+simple-recorder stop
+```
+
+#### Commands:
+
+```shell
+Usage: simple-recorder [OPTIONS] COMMAND
+
+┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ start      Start recording                                                        ┃
+┃ stop       Stop recording                                                         ┃
+┃ pause      Pause recording                                                        ┃
+┃ resume     Resume recording                                                       ┃
+┃ directory  Get or set the recording directory                                     ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ --host <HOST>          OBS WebSocket host                                         ┃
+┃ --port <PORT>          OBS WebSocket port                                         ┃
+┃ --password <PASSWORD>  OBS WebSocket password                                     ┃
+┃ --theme <THEME>        GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach,  ┃
+┃                        Kayak, Light Blue 2)                                       ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+### GUI
+
+To launch the GUI:
+
+```console
+simple-recorder-gui
 ```
 
 ![simple-recorder](./img/simple-recorder.png)
@@ -66,39 +109,7 @@ Just enter the filename and click *Start*.
 You can change the colour theme with the --theme option:
 
 ```console
-simple-recorder --theme="Light Purple"
+simple-recorder-gui --theme="Light Purple"
 ```
 
-### CLI
-
-```shell
-Usage: simple-recorder [OPTIONS] COMMAND
-
-┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-┃ start   Start recording                                                             ┃
-┃ stop    Stop recording                                                              ┃
-┃ pause   Pause recording                                                             ┃
-┃ resume  Resume recording                                                            ┃
-┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-
-┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-┃ --host <HOST>          OBS WebSocket host                                           ┃
-┃ --port <PORT>          OBS WebSocket port                                           ┃
-┃ --password <PASSWORD>  OBS WebSocket password                                       ┃
-┃ --theme <THEME>        GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach,    ┃
-┃                        Kayak, Light Blue 2)                                         ┃
-┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-```
-
-To launch the CLI pass any subcommand (start/stop etc...), for example:
-
-```console
-simple-recorder start "File Name"
-
-simple-recorder stop
-```
-
--   If no filename is passed to start then you will be prompted for one. 
-    -   A default_name will be used if none is supplied to the prompt.
-
 [obs-studio]: https://obsproject.com/

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple-recorder"
-version = "0.2.0"
+version = "0.3.5"
 description = "A simple OBS recorder"
 authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
 dependencies = [
@@ -15,6 +15,9 @@ license = { text = "MIT" }
 [project.scripts]
 simple-recorder = "simple_recorder:run"
 
+[project.gui-scripts]
+simple-recorder-gui = "simple_recorder:run"
+
 [build-system]
 requires = ["pdm-backend"]
 build-backend = "pdm.backend"
@@ -28,6 +31,4 @@ compile = "shiv -c simple-recorder -o bin/simple-recorder.pyz ."
 
 
 [dependency-groups]
-build = [
+build = ["shiv>=1.0.8"]
-    "shiv>=1.0.8",
-]

src/simple_recorder/cli.py

@@ -3,6 +3,7 @@ import logging
 from clypi import ClypiConfig, ClypiException, Command, arg, configure
 from typing_extensions import override
 
+from .directory import Directory
 from .errors import SimpleRecorderError
 from .gui import SimpleRecorderWindow
 from .pause import Pause
@@ -37,7 +38,7 @@ def theme_parser(value: str) -> str:
 
 
 class SimpleRecorder(Command):
-    subcommand: Start | Stop | Pause | Resume | None = None
+    subcommand: Start | Stop | Pause | Resume | Directory | None = None
     host: str = arg(default="localhost", env="OBS_HOST", help="OBS WebSocket host")
     port: int = arg(default=4455, env="OBS_PORT", help="OBS WebSocket port")
     password: str | None = arg(

src/simple_recorder/directory.py

@@ -0,0 +1,36 @@
+import obsws_python as obsws
+from clypi import Command, Positional, arg
+from typing_extensions import override
+
+from .errors import SimpleRecorderError
+from .styler import highlight
+
+
+class Directory(Command):
+    """Get or set the recording directory."""
+
+    directory: Positional[str] = arg(
+        default=None,
+        help="Directory to set for recordings. If not provided, the current directory will be displayed.",
+    )
+    host: str = arg(inherited=True)
+    port: int = arg(inherited=True)
+    password: str = arg(inherited=True)
+
+    @override
+    async def run(self):
+        try:
+            with obsws.ReqClient(
+                host=self.host, port=self.port, password=self.password, timeout=3
+            ) as client:
+                if self.directory:
+                    client.set_record_directory(self.directory)
+                    print(f"Recording directory set to: {highlight(self.directory)}")
+                else:
+                    resp = client.get_record_directory()
+                    print(
+                        f"Current recording directory: {highlight(resp.record_directory)}"
+                    )
+                    return resp.record_directory
+        except (ConnectionRefusedError, TimeoutError):
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/gui.py

@@ -3,6 +3,7 @@ import logging
 import FreeSimpleGUI as fsg
 import obsws_python as obsws
 
+from .directory import Directory
 from .errors import SimpleRecorderError
 from .pause import Pause
 from .resume import Resume
@@ -26,8 +27,11 @@ class SimpleRecorderWindow(fsg.Window):
             ) as client:
                 resp = client.get_version()
                 status_message = f"Connected to OBS {resp.obs_version} ✓"
+                resp = client.get_record_directory()
+                current_directory = resp.record_directory
         except (ConnectionRefusedError, TimeoutError):
             status_message = "Failed to connect to OBS. Is it running?"
+            current_directory = ""
 
         recorder_layout = [
             [fsg.Text("Enter recording filename:", key="-PROMPT-")],
@@ -59,7 +63,7 @@ class SimpleRecorderWindow(fsg.Window):
                 [
                     fsg.Text(
                         f"Status: {status_message}",
-                        key="-OUTPUT-",
+                        key="-OUTPUT-RECORDER-",
                         text_color="white"
                         if status_message.startswith("Connected")
                         else "red",
@@ -70,7 +74,12 @@ class SimpleRecorderWindow(fsg.Window):
 
         settings_layout = [
             [fsg.Text("Enter the filepath for the recording:")],
-            [fsg.InputText("", key="-FILEPATH-", size=(45, 1))],
+            [fsg.InputText(current_directory, key="-FILEPATH-", size=(45, 1))],
+            [
+                fsg.Button("Get Current", key="-GET-CURRENT-", size=(10, 1)),
+                fsg.Button("Update", key="-UPDATE-", size=(10, 1)),
+            ],
+            [fsg.Text("", key="-OUTPUT-SETTINGS-", text_color="white")],
         ]
 
         settings_tab = fsg.Tab("Settings", settings_layout)
@@ -94,6 +103,9 @@ class SimpleRecorderWindow(fsg.Window):
         self["Add Chapter"].bind("<Leave>", " || LEAVE")
         self["Add Chapter"].bind("<Button-3>", " || RIGHT_CLICK")
 
+        self["-GET-CURRENT-"].bind("<Return>", " || RETURN")
+        self["-UPDATE-"].bind("<Return>", " || RETURN")
+
     async def run(self):
         while True:
             event, values = self.read()
@@ -110,11 +122,11 @@ class SimpleRecorderWindow(fsg.Window):
                             port=self.port,
                             password=self.password,
                         ).run()
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             "Recording started successfully", text_color="green"
                         )
                     except SimpleRecorderError as e:
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             f"Error: {e.raw_message}", text_color="red"
                         )
 
@@ -123,11 +135,11 @@ class SimpleRecorderWindow(fsg.Window):
                         await Stop(
                             host=self.host, port=self.port, password=self.password
                         ).run()
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             "Recording stopped successfully", text_color="green"
                         )
                     except SimpleRecorderError as e:
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             f"Error: {e.raw_message}", text_color="red"
                         )
 
@@ -136,11 +148,11 @@ class SimpleRecorderWindow(fsg.Window):
                         await Pause(
                             host=self.host, port=self.port, password=self.password
                         ).run()
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             "Recording paused successfully", text_color="green"
                         )
                     except SimpleRecorderError as e:
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             f"Error: {e.raw_message}", text_color="red"
                         )
 
@@ -149,21 +161,21 @@ class SimpleRecorderWindow(fsg.Window):
                         await Resume(
                             host=self.host, port=self.port, password=self.password
                         ).run()
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             "Recording resumed successfully", text_color="green"
                         )
                     except SimpleRecorderError as e:
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             f"Error: {e.raw_message}", text_color="red"
                         )
 
                 case ["Add Chapter", "FOCUS" | "LEAVE" as focus_event]:
                     if focus_event == "FOCUS":
-                        self["-OUTPUT-"].update(
+                        self["-OUTPUT-RECORDER-"].update(
                             "Right-click to set a chapter name", text_color="white"
                         )
                     else:
-                        self["-OUTPUT-"].update("", text_color="white")
+                        self["-OUTPUT-RECORDER-"].update("", text_color="white")
 
                 case ["Add Chapter", "RIGHT_CLICK"]:
                     _ = fsg.popup_get_text(
@@ -173,10 +185,44 @@ class SimpleRecorderWindow(fsg.Window):
                     )
 
                 case ["Split Recording" | "Add Chapter"]:
-                    self["-OUTPUT-"].update(
+                    self["-OUTPUT-RECORDER-"].update(
                         "This feature is not implemented yet", text_color="orange"
                     )
 
+                case ["-GET-CURRENT-"] | ["-GET-CURRENT-", "RETURN"]:
+                    try:
+                        current_directory = await Directory(
+                            host=self.host, port=self.port, password=self.password
+                        ).run()
+                        self["-FILEPATH-"].update(current_directory)
+                    except SimpleRecorderError as e:
+                        self["-OUTPUT-SETTINGS-"].update(
+                            f"Error: {e.raw_message}", text_color="red"
+                        )
+
+                case ["-UPDATE-"] | ["-UPDATE-", "RETURN"]:
+                    filepath = values["-FILEPATH-"]
+                    if not filepath:
+                        self["-OUTPUT-SETTINGS-"].update(
+                            "Filepath cannot be empty", text_color="red"
+                        )
+                    else:
+                        try:
+                            await Directory(
+                                directory=filepath,
+                                host=self.host,
+                                port=self.port,
+                                password=self.password,
+                            ).run()
+                            self["-OUTPUT-SETTINGS-"].update(
+                                "Recording directory updated successfully.",
+                                text_color="green",
+                            )
+                        except SimpleRecorderError as e:
+                            self["-OUTPUT-SETTINGS-"].update(
+                                f"Error: {e.raw_message}", text_color="red"
+                            )
+
                 case _:
                     self.logger.debug(f"Unhandled event: {e}")
 

src/simple_recorder/pause.py

@@ -26,5 +26,5 @@ class Pause(Command):
 
                 client.pause_record()
                 print("Recording paused successfully.")
-        except TimeoutError:
+        except (ConnectionRefusedError, TimeoutError):
             raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/resume.py

@@ -26,5 +26,5 @@ class Resume(Command):
 
                 client.resume_record()
                 print("Recording resumed successfully.")
-        except TimeoutError:
+        except (ConnectionRefusedError, TimeoutError):
             raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/start.py

@@ -45,5 +45,5 @@ class Start(Command):
                 )
                 client.start_record()
                 print(f"Recording started with filename: {highlight(filename)}")
-        except TimeoutError:
+        except (ConnectionRefusedError, TimeoutError):
             raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/stop.py

@@ -25,5 +25,5 @@ class Stop(Command):
 
                 client.stop_record()
                 print(highlight("Recording stopped successfully."))
-        except TimeoutError:
+        except (ConnectionRefusedError, TimeoutError):
             raise SimpleRecorderError("Failed to connect to OBS. Is it running?")