.gitignore

@@ -131,7 +131,6 @@ ENV/
 env.bak/
 venv.bak/
 .hatch
-.test.env
 
 # Spyder project settings
 .spyderproject

CHANGELOG.md

@@ -1,12 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-# [0.9.2] - 2025-04-26
-
-### Added
-
--   Initial release.

README.md

@@ -3,11 +3,6 @@
 [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
 [![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 command line interface for OBS Websocket v5
-
-For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
-
 -----
 
 ## Table of Contents
@@ -55,9 +50,9 @@ Store and load environment variables from:
 -   `user home directory / .config / obsws-cli / obsws.env`
 
 ```env
-OBS_HOST=localhost
+OBSWS_HOST=localhost
-OBS_PORT=4455
+OBSWS_PORT=4455
-OBS_PASSWORD=<websocket password>
+OBSWS_PASSWORD=<websocket password>
 ```
 
 Flags can be used to override environment variables.

obsws_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.9.2"
+__version__ = "0.9.1"

obsws_cli/app.py

@@ -17,7 +17,6 @@ from . import (
     scene,
     scenecollection,
     sceneitem,
-    stream,
     studiomode,
     virtualcam,
 )
@@ -33,7 +32,7 @@ class Settings(BaseSettings):
             Path.home() / '.config' / 'obsws-cli' / 'obsws.env',
         ),
         env_file_encoding='utf-8',
-        env_prefix='OBS_',
+        env_prefix='OBSWS_',
     )
 
     HOST: str = 'localhost'
@@ -52,7 +51,6 @@ for module in (
     scene,
     scenecollection,
     sceneitem,
-    stream,
     studiomode,
     virtualcam,
 ):

obsws_cli/errors.py

@@ -0,0 +1,18 @@
+"""Exceptions for obsws_cli."""
+
+
+class ObswsCliError(Exception):
+    """Base class for all exceptions raised by obsws_cli."""
+
+    def __init__(self, message: str):
+        """Initialize the exception with a message."""
+        message = (
+            message.split('With message: ')[1]
+            if 'With message: ' in message
+            else message
+        )
+        super().__init__(message)
+
+
+class ObswsCliBadParameter(ObswsCliError):
+    """Exception raised when a bad parameter is passed to a command."""

obsws_cli/group.py

@@ -44,7 +44,7 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
     return group
 
 
-@app.command('show | sh')
+@app.command()
 def show(ctx: typer.Context, scene_name: str, group_name: str):
     """Show a group in a scene."""
     if not validate.scene_in_scenes(ctx, scene_name):
@@ -71,7 +71,7 @@ def show(ctx: typer.Context, scene_name: str, group_name: str):
     typer.echo(f"Group '{group_name}' is now visible.")
 
 
-@app.command('hide | h')
+@app.command()
 def hide(ctx: typer.Context, scene_name: str, group_name: str):
     """Hide a group in a scene."""
     if not validate.scene_in_scenes(ctx, scene_name):
@@ -129,7 +129,7 @@ def toggle(ctx: typer.Context, scene_name: str, group_name: str):
         typer.echo(f"Group '{group_name}' is now hidden.")
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context, scene_name: str, group_name: str):
     """Get the status of a group in a scene."""
     if not validate.scene_in_scenes(ctx, scene_name):

obsws_cli/input.py

@@ -42,7 +42,7 @@ def list(
     typer.echo('\n'.join(input_.get('inputName') for input_ in inputs))
 
 
-@app.command('mute | m')
+@app.command()
 def mute(ctx: typer.Context, input_name: str):
     """Mute an input."""
     if not validate.input_in_inputs(ctx, input_name):
@@ -60,7 +60,7 @@ def mute(ctx: typer.Context, input_name: str):
     typer.echo(f"Input '{input_name}' muted.")
 
 
-@app.command('unmute | um')
+@app.command()
 def unmute(ctx: typer.Context, input_name: str):
     """Unmute an input."""
     if not validate.input_in_inputs(ctx, input_name):

obsws_cli/profile.py

@@ -21,14 +21,14 @@ def list(ctx: typer.Context):
         typer.echo(profile)
 
 
-@app.command('current | get')
+@app.command()
 def current(ctx: typer.Context):
     """Get the current profile."""
     resp = ctx.obj.get_profile_list()
     typer.echo(resp.current_profile_name)
 
 
-@app.command('switch | set')
+@app.command()
 def switch(ctx: typer.Context, profile_name: str):
     """Switch to a profile."""
     if not validate.profile_exists(ctx, profile_name):
@@ -50,7 +50,7 @@ def switch(ctx: typer.Context, profile_name: str):
     typer.echo(f"Switched to profile '{profile_name}'.")
 
 
-@app.command('create | new')
+@app.command()
 def create(ctx: typer.Context, profile_name: str):
     """Create a new profile."""
     if validate.profile_exists(ctx, profile_name):
@@ -64,7 +64,7 @@ def create(ctx: typer.Context, profile_name: str):
     typer.echo(f"Created profile '{profile_name}'.")
 
 
-@app.command('remove | rm')
+@app.command()
 def remove(ctx: typer.Context, profile_name: str):
     """Remove a profile."""
     if not validate.profile_exists(ctx, profile_name):

obsws_cli/record.py

@@ -18,7 +18,7 @@ def _get_recording_status(ctx: typer.Context) -> tuple:
     return resp.output_active, resp.output_paused
 
 
-@app.command('start | s')
+@app.command()
 def start(ctx: typer.Context):
     """Start recording."""
     active, paused = _get_recording_status(ctx)
@@ -34,7 +34,7 @@ def start(ctx: typer.Context):
     typer.echo('Recording started successfully.')
 
 
-@app.command('stop | st')
+@app.command()
 def stop(ctx: typer.Context):
     """Stop recording."""
     active, _ = _get_recording_status(ctx)
@@ -46,7 +46,7 @@ def stop(ctx: typer.Context):
     typer.echo('Recording stopped successfully.')
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context):
     """Get recording status."""
     active, paused = _get_recording_status(ctx)
@@ -69,7 +69,7 @@ def toggle(ctx: typer.Context):
         ctx.invoke(start, ctx=ctx)
 
 
-@app.command('resume | r')
+@app.command()
 def resume(ctx: typer.Context):
     """Resume recording."""
     active, paused = _get_recording_status(ctx)
@@ -84,7 +84,7 @@ def resume(ctx: typer.Context):
     typer.echo('Recording resumed successfully.')
 
 
-@app.command('pause | p')
+@app.command()
 def pause(ctx: typer.Context):
     """Pause recording."""
     active, paused = _get_recording_status(ctx)

obsws_cli/replaybuffer.py

@@ -12,21 +12,21 @@ def main():
     """Control profiles in OBS."""
 
 
-@app.command('start | s')
+@app.command()
 def start(ctx: typer.Context):
     """Start the replay buffer."""
     ctx.obj.start_replay_buffer()
     typer.echo('Replay buffer started.')
 
 
-@app.command('stop | st')
+@app.command()
 def stop(ctx: typer.Context):
     """Stop the replay buffer."""
     ctx.obj.stop_replay_buffer()
     typer.echo('Replay buffer stopped.')
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context):
     """Get the status of the replay buffer."""
     resp = ctx.obj.get_replay_buffer_status()
@@ -36,7 +36,7 @@ def status(ctx: typer.Context):
         typer.echo('Replay buffer is not active.')
 
 
-@app.command('save | sv')
+@app.command()
 def save(ctx: typer.Context):
     """Save the replay buffer."""
     ctx.obj.save_replay_buffer()

obsws_cli/sceneitem.py

@@ -77,7 +77,7 @@ def _get_scene_name_and_item_id(
 
 
 @_validate_scene_name_and_item_name
-@app.command('show | sh')
+@app.command()
 def show(
     ctx: typer.Context,
     scene_name: str,
@@ -99,7 +99,7 @@ def show(
 
 
 @_validate_scene_name_and_item_name
-@app.command('hide | h')
+@app.command()
 def hide(
     ctx: typer.Context,
     scene_name: str,
@@ -164,7 +164,7 @@ def toggle(
 
 
 @_validate_scene_name_and_item_name
-@app.command('visible | v')
+@app.command()
 def visible(
     ctx: typer.Context,
     scene_name: str,
@@ -206,7 +206,7 @@ def visible(
 
 
 @_validate_scene_name_and_item_name
-@app.command('transform | t')
+@app.command()
 def transform(
     ctx: typer.Context,
     scene_name: str,

obsws_cli/stream.py

@@ -18,7 +18,7 @@ def _get_streaming_status(ctx: typer.Context) -> tuple:
     return resp.output_active, resp.output_duration
 
 
-@app.command('start | s')
+@app.command()
 def start(ctx: typer.Context):
     """Start streaming."""
     active, _ = _get_streaming_status(ctx)
@@ -30,7 +30,7 @@ def start(ctx: typer.Context):
     typer.echo('Streaming started successfully.')
 
 
-@app.command('stop | st')
+@app.command()
 def stop(ctx: typer.Context):
     """Stop streaming."""
     active, _ = _get_streaming_status(ctx)
@@ -42,7 +42,7 @@ def stop(ctx: typer.Context):
     typer.echo('Streaming stopped successfully.')
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context):
     """Get streaming status."""
     active, duration = _get_streaming_status(ctx)

obsws_cli/studiomode.py

@@ -12,19 +12,19 @@ def main():
     """Control studio mode in OBS."""
 
 
-@app.command('enable | on')
+@app.command()
 def enable(ctx: typer.Context):
     """Enable studio mode."""
     ctx.obj.set_studio_mode_enabled(True)
 
 
-@app.command('disable | off')
+@app.command()
 def disable(ctx: typer.Context):
     """Disable studio mode."""
     ctx.obj.set_studio_mode_enabled(False)
 
 
-@app.command('toggle | tg')
+@app.command()
 def toggle(ctx: typer.Context):
     """Toggle studio mode."""
     resp = ctx.obj.get_studio_mode_enabled()
@@ -36,7 +36,7 @@ def toggle(ctx: typer.Context):
         typer.echo('Studio mode is now enabled.')
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context):
     """Get the status of studio mode."""
     resp = ctx.obj.get_studio_mode_enabled()

obsws_cli/virtualcam.py

@@ -12,28 +12,28 @@ def main():
     """Control virtual camera in OBS."""
 
 
-@app.command('start | s')
+@app.command()
 def start(ctx: typer.Context):
     """Start the virtual camera."""
     ctx.obj.start_virtual_cam()
     typer.echo('Virtual camera started.')
 
 
-@app.command('stop | p')
+@app.command()
 def stop(ctx: typer.Context):
     """Stop the virtual camera."""
     ctx.obj.stop_virtual_cam()
     typer.echo('Virtual camera stopped.')
 
 
-@app.command('toggle | tg')
+@app.command()
 def toggle(ctx: typer.Context):
     """Toggle the virtual camera."""
     ctx.obj.toggle_virtual_cam()
     typer.echo('Virtual camera toggled.')
 
 
-@app.command('status | ss')
+@app.command()
 def status(ctx: typer.Context):
     """Get the status of the virtual camera."""
     resp = ctx.obj.get_virtual_cam_status()

pyproject.toml

@@ -40,9 +40,10 @@ path = "obsws_cli/__about__.py"
 
 [tool.hatch.envs.default.scripts]
 cli = "obsws-cli {args:}"
+test = "pytest {args:obsws_cli tests}"
 
 [tool.hatch.envs.hatch-test]
-dependencies = ["pytest>=8.3.5"]
+dependencies = ["pytest>=8.3.5", "pytest-dotenv"]
 
 [tool.hatch.envs.types]
 extra-dependencies = ["mypy>=1.0.0"]

tests/conftest.py

@@ -3,7 +3,6 @@
 import os
 
 import obsws_python as obsws
-from dotenv import find_dotenv, load_dotenv
 
 
 def pytest_configure(config):
@@ -20,9 +19,9 @@ def pytest_sessionstart(session):
     """
     # Initialize the OBS WebSocket client
     session.obsws = obsws.ReqClient(
-        host=os.environ['OBS_HOST'],
+        host=os.environ['OBSWS_HOST'],
-        port=os.environ['OBS_PORT'],
+        port=os.environ['OBSWS_PORT'],
-        password=os.environ['OBS_PASSWORD'],
+        password=os.environ['OBSWS_PASSWORD'],
         timeout=5,
     )
     resp = session.obsws.get_version()
@@ -33,17 +32,6 @@ def pytest_sessionstart(session):
     )
     print(' '.join(out))
 
-    load_dotenv(find_dotenv('.test.env'))
-
-    session.obsws.set_stream_service_settings(
-        'rtmp_common',
-        {
-            'service': 'Twitch',
-            'server': 'auto',
-            'key': os.environ['OBS_STREAM_KEY'],
-        },
-    )
-
     session.obsws.set_current_scene_collection('test-collection')
 
     session.obsws.create_scene('pytest')
@@ -80,10 +68,6 @@ def pytest_sessionfinish(session, exitstatus):
     """
     session.obsws.remove_scene('pytest')
 
-    resp = session.obsws.get_stream_status()
-    if resp.output_active:
-        session.obsws.stop_stream()
-
     # Close the OBS WebSocket client connection
     session.obsws.disconnect()
 

tests/test_group.py

@@ -9,35 +9,35 @@ runner = CliRunner()
 
 def test_group_list():
     """Test the group list command."""
-    result = runner.invoke(app, ['group', 'list', 'Scene'])
+    result = runner.invoke(app, ['group', 'list', 'pytest00'])
     assert result.exit_code == 0
     assert 'test_group' in result.stdout
 
 
 def test_group_show():
     """Test the group show command."""
-    result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
+    result = runner.invoke(app, ['group', 'show', 'pytest00', 'test_group'])
     assert result.exit_code == 0
     assert "Group 'test_group' is now visible." in result.stdout
 
 
 def test_group_toggle():
     """Test the group toggle command."""
-    result = runner.invoke(app, ['group', 'hide', 'Scene', 'test_group'])
+    result = runner.invoke(app, ['group', 'hide', 'pytest00', 'test_group'])
     assert result.exit_code == 0
     assert "Group 'test_group' is now hidden." in result.stdout
 
-    result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
+    result = runner.invoke(app, ['group', 'toggle', 'pytest00', 'test_group'])
     assert result.exit_code == 0
     assert "Group 'test_group' is now visible." in result.stdout
 
 
 def test_group_status():
     """Test the group status command."""
-    result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
+    result = runner.invoke(app, ['group', 'show', 'pytest00', 'test_group'])
     assert result.exit_code == 0
     assert "Group 'test_group' is now visible." in result.stdout
 
-    result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
+    result = runner.invoke(app, ['group', 'status', 'pytest00', 'test_group'])
     assert result.exit_code == 0
     assert "Group 'test_group' is now visible." in result.stdout

tests/test_stream.py

@@ -1,43 +0,0 @@
-"""Unit tests for the stream commands in the OBS WebSocket CLI."""
-
-import time
-
-from typer.testing import CliRunner
-
-from obsws_cli.app import app
-
-runner = CliRunner()
-
-
-def test_stream_start():
-    """Test the stream start command."""
-    result = runner.invoke(app, ['stream', 'status'])
-    assert result.exit_code == 0
-    active = 'Streaming is in progress' in result.stdout
-
-    result = runner.invoke(app, ['stream', 'start'])
-    assert result.exit_code == 0
-
-    time.sleep(1)  # Wait for the stream to start
-
-    if active:
-        assert 'Streaming is already in progress, cannot start.' in result.stdout
-    else:
-        assert 'Streaming started successfully.' in result.stdout
-
-
-def test_stream_stop():
-    """Test the stream stop command."""
-    result = runner.invoke(app, ['stream', 'status'])
-    assert result.exit_code == 0
-    active = 'Streaming is in progress' in result.stdout
-
-    result = runner.invoke(app, ['stream', 'stop'])
-    assert result.exit_code == 0
-
-    time.sleep(1)  # Wait for the stream to stop
-
-    if active:
-        assert 'Streaming stopped successfully.' in result.stdout
-    else:
-        assert 'Streaming is not in progress, cannot stop.' in result.stdout

tests/test_studiomode.py

@@ -1,27 +0,0 @@
-"""Unit tests for the studio mode command in the OBS WebSocket CLI."""
-
-from typer.testing import CliRunner
-
-from obsws_cli.app import app
-
-runner = CliRunner()
-
-
-def test_studio_enable():
-    """Test the studio enable command."""
-    result = runner.invoke(app, ['studiomode', 'enable'])
-    assert result.exit_code == 0
-
-    result = runner.invoke(app, ['studiomode', 'status'])
-    assert result.exit_code == 0
-    assert 'Studio mode is enabled.' in result.stdout
-
-
-def test_studio_disable():
-    """Test the studio disable command."""
-    result = runner.invoke(app, ['studiomode', 'disable'])
-    assert result.exit_code == 0
-
-    result = runner.invoke(app, ['studiomode', 'status'])
-    assert result.exit_code == 0
-    assert 'Studio mode is disabled.' in result.stdout