patch bump

envconfig:
- add method for normalising the keys
- add has_key method
- update env var prefix to OBSWS_CLI_

update tests to reflect changes

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.24.6] - 2026-01-26
+
+### Changed
+
+-   environment variables should now be prefixed with 'OBSWS_CLI_', see [Environment Variables](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#environment-variables)
+
 # [0.24.0] - 2026-01-09
 
 ### Added

README.md

@@ -62,9 +62,9 @@ Store and load environment variables from:
 -   `user home directory / .config / obsws-cli / obsws.env`
 
 ```env
-OBS_HOST=localhost
+OBSWS_CLI_HOST=localhost
-OBS_PORT=4455
+OBSWS_CLI_PORT=4455
-OBS_PASSWORD=<websocket password>
+OBSWS_CLI_PASSWORD=<websocket password>
 ```
 
 Flags can be used to override environment variables.
@@ -96,8 +96,8 @@ obsws-cli --style="cyan" --no-border sceneitem list
 Or with environment variables:
 
 ```env
-OBS_STYLE=cyan
+OBSWS_CLI_STYLE=cyan
-OBS_STYLE_NO_BORDER=true
+OBSWS_CLI_STYLE_NO_BORDER=true
 ```
 
 ## Root Typer

obsws_cli/__about__.py

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

obsws_cli/app.py

@@ -2,6 +2,7 @@
 
 import importlib
 import logging
+import pkgutil
 from typing import Annotated
 
 import obsws_python as obsws
@@ -9,32 +10,15 @@ import typer
 
 from obsws_cli.__about__ import __version__ as version
 
-from . import config, console, styles
+from . import commands, console, envconfig, styles
 from .alias import RootTyperAliasGroup
 
 app = typer.Typer(cls=RootTyperAliasGroup)
-for sub_typer in (
+for importer, modname, ispkg in pkgutil.iter_modules(
-    'filter',
+    commands.__path__, commands.__name__ + '.'
-    'group',
-    'hotkey',
-    'input',
-    'media',
-    'profile',
-    'projector',
-    'record',
-    'replaybuffer',
-    'scene',
-    'scenecollection',
-    'sceneitem',
-    'screenshot',
-    'settings',
-    'stream',
-    'studiomode',
-    'text',
-    'virtualcam',
 ):
-    module = importlib.import_module(f'.{sub_typer}', package=__package__)
+    subtyper = importlib.import_module(modname)
-    app.add_typer(module.app, name=sub_typer)
+    app.add_typer(subtyper.app, name=modname.split('.')[-1])
 
 
 def version_callback(value: bool):
@@ -70,62 +54,62 @@ def main(
         typer.Option(
             '--host',
             '-H',
-            envvar='OBS_HOST',
+            envvar='OBSWS_CLI_HOST',
             help='WebSocket host',
             show_default='localhost',
         ),
-    ] = config.get('host'),
+    ] = envconfig.get('host'),
     port: Annotated[
         int,
         typer.Option(
             '--port',
             '-P',
-            envvar='OBS_PORT',
+            envvar='OBSWS_CLI_PORT',
             help='WebSocket port',
             show_default=4455,
         ),
-    ] = config.get('port'),
+    ] = envconfig.get('port'),
     password: Annotated[
         str,
         typer.Option(
             '--password',
             '-p',
-            envvar='OBS_PASSWORD',
+            envvar='OBSWS_CLI_PASSWORD',
             help='WebSocket password',
             show_default=False,
         ),
-    ] = config.get('password'),
+    ] = envconfig.get('password'),
     timeout: Annotated[
         int,
         typer.Option(
             '--timeout',
             '-T',
-            envvar='OBS_TIMEOUT',
+            envvar='OBSWS_CLI_TIMEOUT',
             help='WebSocket timeout',
             show_default=5,
         ),
-    ] = config.get('timeout'),
+    ] = envconfig.get('timeout'),
     style: Annotated[
         str,
         typer.Option(
             '--style',
             '-s',
-            envvar='OBS_STYLE',
+            envvar='OBSWS_CLI_STYLE',
             help='Set the style for the CLI output',
             show_default='disabled',
             callback=validate_style,
         ),
-    ] = config.get('style'),
+    ] = envconfig.get('style'),
     no_border: Annotated[
         bool,
         typer.Option(
             '--no-border',
             '-b',
-            envvar='OBS_STYLE_NO_BORDER',
+            envvar='OBSWS_CLI_STYLE_NO_BORDER',
             help='Disable table border styling in the CLI output',
             show_default=False,
         ),
-    ] = config.get('style_no_border'),
+    ] = envconfig.get('style_no_border'),
     version: Annotated[
         bool,
         typer.Option(
@@ -142,14 +126,14 @@ def main(
         typer.Option(
             '--debug',
             '-d',
-            envvar='OBS_DEBUG',
+            envvar='OBSWS_CLI_DEBUG',
             is_eager=True,
             help='Enable debug logging',
             show_default=False,
             callback=setup_logging,
             hidden=True,
         ),
-    ] = config.get('debug'),
+    ] = envconfig.get('debug'),
 ):
     """obsws_cli is a command line interface for the OBS WebSocket API."""
     ctx.ensure_object(dict)

obsws_cli/commands/filter.py

@@ -7,8 +7,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util
+from obsws_cli import console, util
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/group.py

@@ -6,9 +6,9 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
-from .protocols import DataclassProtocol
+from obsws_cli.protocols import DataclassProtocol
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/hotkey.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/input.py

@@ -7,8 +7,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/media.py

@@ -4,8 +4,8 @@ from typing import Annotated, Optional
 
 import typer
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/profile.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/projector.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/record.py

@@ -5,8 +5,8 @@ from typing import Annotated, Optional
 
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/replaybuffer.py

@@ -2,8 +2,8 @@
 
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/scene.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/scenecollection.py

@@ -5,8 +5,8 @@ from typing import Annotated
 import typer
 from rich.table import Table
 
-from . import console, validate
+from obsws_cli import console, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/sceneitem.py

@@ -5,8 +5,8 @@ from typing import Annotated, Optional
 import typer
 from rich.table import Table
 
-from . import console, util, validate
+from obsws_cli import console, util, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/screenshot.py

@@ -6,8 +6,8 @@ from typing import Annotated
 import obsws_python as obsws
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/settings.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 from rich.text import Text
 
-from . import console, util
+from obsws_cli import console, util
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/stream.py

@@ -2,8 +2,8 @@
 
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/studiomode.py

@@ -2,8 +2,8 @@
 
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/text.py

@@ -4,8 +4,8 @@ from typing import Annotated, Optional
 
 import typer
 
-from . import console, validate
+from obsws_cli import console, validate
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/commands/virtualcam.py

@@ -2,8 +2,8 @@
 
 import typer
 
-from . import console
+from obsws_cli import console
-from .alias import SubTyperAliasGroup
+from obsws_cli.alias import SubTyperAliasGroup
 
 app = typer.Typer(cls=SubTyperAliasGroup)
 

obsws_cli/config.py

@@ -1,80 +0,0 @@
-"""module for settings management for obsws-cli."""
-
-from collections import UserDict
-from pathlib import Path
-
-from dotenv import dotenv_values
-
-ConfigValue = str | int
-
-
-class Config(UserDict):
-    """A class to manage config for obsws-cli.
-
-    This class extends UserDict to provide a dictionary-like interface for config.
-    It loads config from environment variables and .env files.
-    The config values are expected to be in uppercase and should start with 'OBS_'.
-
-    Example:
-    -------
-        config = Config()
-        host = config['OBS_HOST']
-        config['OBS_PORT'] = 4455
-
-    """
-
-    PREFIX = 'OBS_'
-
-    def __init__(self, *args, **kwargs):
-        """Initialize the Settings object."""
-        kwargs.update(
-            {
-                **dotenv_values('.env'),
-                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
-            }
-        )
-        super().__init__(*args, **kwargs)
-
-    def __getitem__(self, key: str) -> ConfigValue:
-        """Get a setting value by key."""
-        key = key.upper()
-        if not key.startswith(Config.PREFIX):
-            key = f'{Config.PREFIX}{key}'
-        return self.data[key]
-
-    def __setitem__(self, key: str, value: ConfigValue):
-        """Set a setting value by key."""
-        key = key.upper()
-        if not key.startswith(Config.PREFIX):
-            key = f'{Config.PREFIX}{key}'
-        self.data[key] = value
-
-
-_config = Config(
-    OBS_HOST='localhost',
-    OBS_PORT=4455,
-    OBS_PASSWORD='',
-    OBS_TIMEOUT=5,
-    OBS_DEBUG=False,
-    OBS_STYLE='disabled',
-    OBS_STYLE_NO_BORDER=False,
-)
-
-
-def get(key: str) -> ConfigValue:
-    """Get a setting value by key.
-
-    Args:
-    ----
-        key (str): The key of the config to retrieve.
-
-    Returns:
-    -------
-        The value of the config.
-
-    Raises:
-    ------
-        KeyError: If the key does not exist in the config.
-
-    """
-    return _config[key]

obsws_cli/envconfig.py

@@ -0,0 +1,146 @@
+"""module for settings management for obsws-cli."""
+
+from collections import UserDict
+from pathlib import Path
+from typing import Any, Union
+
+from dotenv import dotenv_values
+
+ConfigValue = Union[str, int, bool]
+
+
+class EnvConfig(UserDict):
+    """A class to manage .env config for obsws-cli.
+
+    This class extends UserDict to provide a dictionary-like interface for config.
+    It loads config from .env files in the following priority:
+    1. Local .env file
+    2. User config file (~/.config/obsws-cli/obsws.env)
+    3. Default values
+
+    Note, typer handles reading from environment variables automatically. They take precedence
+    over values set in this class.
+
+    The config values are expected to be in uppercase and should start with 'OBSWS_CLI_'.
+
+    Example:
+    -------
+        config = EnvConfig()
+        host = config['OBSWS_CLI_HOST']
+        config['OBSWS_CLI_PORT'] = 4455
+        # Or with defaults
+        timeout = config.get('OBSWS_CLI_TIMEOUT', 30)
+        # Keys will be normalised to uppercase with prefix
+        debug = config.get('debug', False)  # Equivalent to 'OBSWS_CLI_DEBUG'
+
+    """
+
+    PREFIX = 'OBSWS_CLI_'
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the Config object with hierarchical loading."""
+        kwargs.update(
+            {
+                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
+                **dotenv_values('.env'),
+            }
+        )
+
+        super().__init__(*args, **self._convert_types(kwargs))
+
+    def _convert_types(self, config_data: dict[str, Any]) -> dict[str, ConfigValue]:
+        """Convert string values to appropriate types."""
+        converted = {}
+        for key, value in config_data.items():
+            if isinstance(value, str):
+                if value.lower() in ('true', 'false'):
+                    converted[key] = value.lower() == 'true'
+                elif value.isdigit():
+                    converted[key] = int(value)
+                else:
+                    converted[key] = value
+            else:
+                converted[key] = value
+        return converted
+
+    def __getitem__(self, key: str) -> ConfigValue:
+        """Get a setting value by key."""
+        normalised_key = self._normalise_key(key)
+        try:
+            return self.data[normalised_key]
+        except KeyError as e:
+            raise KeyError(
+                f"Config key '{key}' not found. Available keys: {list(self.data.keys())}"
+            ) from e
+
+    def __setitem__(self, key: str, value: ConfigValue):
+        """Set a setting value by key."""
+        normalised_key = self._normalise_key(key)
+        self.data[normalised_key] = value
+
+    def _normalise_key(self, key: str) -> str:
+        """Normalise a key to uppercase with OBS_ prefix."""
+        key = key.upper()
+        if not key.startswith(self.PREFIX):
+            key = f'{self.PREFIX}{key}'
+        return key
+
+    def get(self, key: str, default=None) -> ConfigValue:
+        """Get a config value with optional default.
+
+        Args:
+        ----
+            key (str): The key to retrieve
+            default: Default value if key is not found
+
+        Returns:
+        -------
+            The config value or default
+
+        """
+        normalised_key = self._normalise_key(key)
+        if not self.has_key(normalised_key):
+            return default
+        return self[normalised_key]
+
+    def has_key(self, key: str) -> bool:
+        """Check if a config key exists.
+
+        Args:
+        ----
+            key (str): The key to check
+
+        Returns:
+        -------
+            bool: True if key exists, False otherwise
+
+        """
+        normalised_key = self._normalise_key(key)
+        return normalised_key in self.data
+
+
+_envconfig = EnvConfig(
+    OBSWS_CLI_HOST='localhost',
+    OBSWS_CLI_PORT=4455,
+    OBSWS_CLI_PASSWORD='',
+    OBSWS_CLI_TIMEOUT=5,
+    OBSWS_CLI_DEBUG=False,
+    OBSWS_CLI_STYLE='disabled',
+    OBSWS_CLI_STYLE_NO_BORDER=False,
+)
+
+
+def get(key: str) -> ConfigValue:
+    """Get a setting value by key from the global config instance.
+
+    Args:
+    ----
+        key (str): The key of the config to retrieve.
+        default: Default value if key is not found.
+
+    Returns:
+    -------
+        The value of the config or default value.
+
+    """
+    return _envconfig.get(key)

tests/conftest.py

@@ -21,9 +21,9 @@ def pytest_sessionstart(session):
     """
     # Initialize the OBS WebSocket client
     session.obsws = obsws.ReqClient(
-        host=os.environ['OBS_HOST'],
+        host=os.environ['OBSWS_CLI_HOST'],
-        port=os.environ['OBS_PORT'],
+        port=os.environ['OBSWS_CLI_PORT'],
-        password=os.environ['OBS_PASSWORD'],
+        password=os.environ['OBSWS_CLI_PASSWORD'],
         timeout=5,
     )
     resp = session.obsws.get_version()