set timeout for directory command

initialise current_directory to empty value if the request fails.

patch bump

.github/workflows/build.yml

@@ -1,62 +0,0 @@
-name: Build PYZ
-
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-
-  pull_request:
-    branches: [main]
-
-  workflow_dispatch:
-
-permissions:
-  contents: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up PDM
-        uses: pdm-project/setup-pdm@v4
-        with:
-          python-version: '3.11'
-
-      - name: Install dependencies
-        run: |
-          pdm sync -d -G build
-
-      - name: Build addon
-        run: pdm run compile
-
-      - name: Upload build artifacts
-        if: success()
-        uses: actions/upload-artifact@v4
-        with:
-          name: pyz_build
-          path: ./bin/simple-recorder.pyz
-
-  upload_release:
-    runs-on: ubuntu-latest
-    if: ${{ startsWith(github.ref, 'refs/tags/') }}
-    needs: build
-
-    steps:
-      - name: Download releases files
-        uses: actions/download-artifact@v4.1.7
-        with:
-          name: pyz_build
-
-      - name: Display structure of downloaded files
-        run: tree
-
-      - name: Release
-        uses: softprops/action-gh-release@v1
-        with:
-          files: simple-recorder.pyz
-          fail_on_unmatched_files: true
-          prerelease: ${{ contains(github.ref, '-') }}

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # This permission is needed for private repositories.
+      contents: read
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pdm-project/setup-pdm@v4
+
+      - name: Publish package distributions to PyPI
+        run: pdm publish

.github/workflows/release.yml

@@ -1,26 +1,62 @@
-name: Release
+name: Release PYZ
 
 on:
-  release:
-    types: [published]
   push:
     tags:
       - 'v*.*.*'
 
-jobs:
+  pull_request:
-  pypi-publish:
+    branches: [main]
-    name: upload release to PyPI
+
-    runs-on: ubuntu-latest
+  workflow_dispatch:
-    environment: pypi
+
 permissions:
-      # This permission is needed for private repositories.
+  contents: write
-      contents: read
+
-      # IMPORTANT: this permission is mandatory for trusted publishing
+jobs:
-      id-token: write
+  build:
+    runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-      - uses: pdm-project/setup-pdm@v4
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: '3.11'
 
-      - name: Publish package distributions to PyPI
+      - name: Install dependencies
-        run: pdm publish
+        run: |
+          pdm sync -d -G build
+
+      - name: Build addon
+        run: pdm run compile
+
+      - name: Upload build artifacts
+        if: success()
+        uses: actions/upload-artifact@v4
+        with:
+          name: pyz_build
+          path: ./bin/simple-recorder.pyz
+
+  upload_release:
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/') }}
+    needs: build
+
+    steps:
+      - name: Download releases files
+        uses: actions/download-artifact@v4.1.7
+        with:
+          name: pyz_build
+
+      - name: Display structure of downloaded files
+        run: tree
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: simple-recorder.pyz
+          fail_on_unmatched_files: true
+          prerelease: ${{ contains(github.ref, '-') }}

.github/workflows/ruff.yml

@@ -0,0 +1,19 @@
+name: Ruff
+
+on:
+  push:
+    branches: [main]
+
+  pull_request:
+    branches: [main]
+
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: 'format --check --diff'

README.md

@@ -3,9 +3,7 @@
 [![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-A single purpose application for naming file recording in OBS.
+A simple OBS recorder app. Run it as a CLI or a GUI.
-
-Run it as a CLI or a GUI.
 
 ---
 
@@ -51,6 +49,38 @@ OBS_THEME=Reds
 
 ## Use
 
+### CLI
+
+To launch the CLI pass any subcommand, for example:
+
+```console
+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 run the root command without any subcommands:
@@ -61,44 +91,14 @@ simple-recorder
 
 ![simple-recorder](./img/simple-recorder.png)
 
-Just enter the filename and click *Start Recording*.
+Just enter the filename and click *Start*.
 
 #### Themes
 
-However, passing flags is fine, for example to set the theme:
+You can change the colour theme with the --theme option:
 
 ```console
 simple-recorder --theme="Light Purple"
 ```
 
-### CLI
-
-```shell
-Usage: simple-recorder [OPTIONS] COMMAND
-
-┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-┃ start  Start recording                                                              ┃
-┃ stop   Stop 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.1.7"
+version = "0.3.2"
 description = "A simple OBS recorder"
 authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
 dependencies = [

src/simple_recorder/cli.py

@@ -3,8 +3,11 @@ 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
+from .resume import Resume
 from .start import Start
 from .stop import Stop
 
@@ -35,7 +38,7 @@ def theme_parser(value: str) -> str:
 
 
 class SimpleRecorder(Command):
-    subcommand: Start | Stop | 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 TimeoutError:
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/gui.py

@@ -1,8 +1,12 @@
 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
 from .start import Start
 from .stop import Stop
 
@@ -17,16 +21,87 @@ class SimpleRecorderWindow(fsg.Window):
         self.password = password
         fsg.theme(theme)
 
-        layout = [
+        try:
-            [fsg.Text("Enter recording filename:")],
+            with obsws.ReqClient(
-            [fsg.InputText("", key="-FILENAME-")],
+                host=self.host, port=self.port, password=self.password, timeout=3
-            [fsg.Button("Start Recording"), fsg.Button("Stop Recording")],
+            ) as client:
-            [fsg.Text("Status: Not started", key="-OUTPUT-")],
+                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-")],
+            [fsg.InputText("default_name", key="-FILENAME-", focus=True)],
+            [
+                fsg.Button("Start", key="Start Recording", size=(20, 1)),
+                fsg.Button("Stop", key="Stop Recording", size=(20, 1)),
+            ],
+            [
+                fsg.Button("Pause", key="Pause Recording", size=(20, 1)),
+                fsg.Button("Resume", key="Resume Recording", size=(20, 1)),
+            ],
+            [
+                fsg.Button("Split", key="Split Recording", size=(20, 1)),
+                fsg.Button("Add Chapter", key="Add Chapter", size=(20, 1)),
+            ],
         ]
-        super().__init__("Simple Recorder", layout, finalize=True)
+
+        frame = fsg.Frame(
+            "",
+            recorder_layout,
+            relief=fsg.RELIEF_SUNKEN,
+        )
+
+        recorder_tab = fsg.Tab(
+            "Recorder",
+            [
+                [frame],
+                [
+                    fsg.Text(
+                        f"Status: {status_message}",
+                        key="-OUTPUT-RECORDER-",
+                        text_color="white"
+                        if status_message.startswith("Connected")
+                        else "red",
+                    )
+                ],
+            ],
+        )
+
+        settings_layout = [
+            [fsg.Text("Enter the filepath for the recording:")],
+            [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)
+
+        mainframe = [
+            [fsg.TabGroup([[recorder_tab, settings_tab]])],
+        ]
+
+        super().__init__("Simple Recorder", mainframe, finalize=True)
         self["-FILENAME-"].bind("<Return>", " || RETURN")
         self["Start Recording"].bind("<Return>", " || RETURN")
         self["Stop Recording"].bind("<Return>", " || RETURN")
+        self["Pause Recording"].bind("<Return>", " || RETURN")
+        self["Resume Recording"].bind("<Return>", " || RETURN")
+
+        self["-FILENAME-"].bind("<KeyPress>", " || KEYPRESS")
+        self["-FILENAME-"].update(select=True)
+        self["Add Chapter"].bind("<FocusIn>", " || FOCUS")
+        self["Add Chapter"].bind("<Enter>", " || FOCUS")
+        self["Add Chapter"].bind("<FocusOut>", " || LEAVE")
+        self["Add Chapter"].bind("<Leave>", " || LEAVE")
+        self["Add Chapter"].bind("<Button-3>", " || RIGHT_CLICK")
 
     async def run(self):
         while True:
@@ -44,11 +119,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"
                         )
 
@@ -57,15 +132,95 @@ 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"
+                        )
+
+                case ["Pause Recording"] | ["Pause Recording", "RETURN"]:
+                    try:
+                        await Pause(
+                            host=self.host, port=self.port, password=self.password
+                        ).run()
+                        self["-OUTPUT-RECORDER-"].update(
+                            "Recording paused successfully", text_color="green"
+                        )
+                    except SimpleRecorderError as e:
+                        self["-OUTPUT-RECORDER-"].update(
+                            f"Error: {e.raw_message}", text_color="red"
+                        )
+
+                case ["Resume Recording"] | ["Resume Recording", "RETURN"]:
+                    try:
+                        await Resume(
+                            host=self.host, port=self.port, password=self.password
+                        ).run()
+                        self["-OUTPUT-RECORDER-"].update(
+                            "Recording resumed successfully", text_color="green"
+                        )
+                    except SimpleRecorderError as e:
+                        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-RECORDER-"].update(
+                            "Right-click to set a chapter name", text_color="white"
+                        )
+                    else:
+                        self["-OUTPUT-RECORDER-"].update("", text_color="white")
+
+                case ["Add Chapter", "RIGHT_CLICK"]:
+                    _ = fsg.popup_get_text(
+                        "Enter chapter name:",
+                        "Add Chapter",
+                        default_text="unnamed",
+                    )
+
+                case ["Split Recording" | "Add Chapter"]:
+                    self["-OUTPUT-RECORDER-"].update(
+                        "This feature is not implemented yet", text_color="orange"
+                    )
+
+                case ["-GET-CURRENT-"]:
+                    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-"]:
+                    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.warning(f"Unhandled event: {e}")
+                    self.logger.debug(f"Unhandled event: {e}")
 
         self.close()

src/simple_recorder/pause.py

@@ -0,0 +1,30 @@
+import obsws_python as obsws
+from clypi import Command, arg
+from typing_extensions import override
+
+from .errors import SimpleRecorderError
+
+
+class Pause(Command):
+    """Pause recording."""
+
+    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:
+                resp = client.get_record_status()
+                if not resp.output_active:
+                    raise SimpleRecorderError("No active recording to pause.")
+                if resp.output_paused:
+                    raise SimpleRecorderError("Recording is already paused.")
+
+                client.pause_record()
+                print("Recording paused successfully.")
+        except TimeoutError:
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/resume.py

@@ -0,0 +1,30 @@
+import obsws_python as obsws
+from clypi import Command, arg
+from typing_extensions import override
+
+from .errors import SimpleRecorderError
+
+
+class Resume(Command):
+    """Resume recording."""
+
+    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:
+                resp = client.get_record_status()
+                if not resp.output_active:
+                    raise SimpleRecorderError("No active recording to resume.")
+                if not resp.output_paused:
+                    raise SimpleRecorderError("Recording is not paused.")
+
+                client.resume_record()
+                print("Recording resumed successfully.")
+        except TimeoutError:
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/start.py

@@ -29,8 +29,9 @@ class Start(Command):
         if not self.filename:
             raise SimpleRecorderError("Recording name cannot be empty.")
 
+        try:
             with obsws.ReqClient(
-            host=self.host, port=self.port, password=self.password
+                host=self.host, port=self.port, password=self.password, timeout=3
             ) as client:
                 resp = client.get_record_status()
                 if resp.output_active:
@@ -44,3 +45,5 @@ class Start(Command):
                 )
                 client.start_record()
                 print(f"Recording started with filename: {highlight(filename)}")
+        except TimeoutError:
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")

src/simple_recorder/stop.py

@@ -15,8 +15,9 @@ class Stop(Command):
 
     @override
     async def run(self):
+        try:
             with obsws.ReqClient(
-            host=self.host, port=self.port, password=self.password
+                host=self.host, port=self.port, password=self.password, timeout=3
             ) as client:
                 resp = client.get_record_status()
                 if not resp.output_active:
@@ -24,3 +25,5 @@ class Stop(Command):
 
                 client.stop_record()
                 print(highlight("Recording stopped successfully."))
+        except TimeoutError:
+            raise SimpleRecorderError("Failed to connect to OBS. Is it running?")