in case NO_COLOR is set manually

patch bump

CHANGELOG.md

@@ -5,6 +5,15 @@ 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.18.0] - 2025-06-21
+
+### Added
+
+-   Various colouring styles, see [Style](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#style)
+    -   colouring is applied to list tables as well as highlighted information in stdout/stderr output.
+    -   table border styling may be optionally disabled with the --no-border flag.
+
+
 # [0.17.3] - 2025-06-20
 
 ### Added

obsws_cli/__about__.py

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

obsws_cli/app.py

@@ -7,7 +7,7 @@ from typing import Annotated
 import obsws_python as obsws
 import typer
 
-from obsws_cli.__about__ import __version__ as obsws_cli_version
+from obsws_cli.__about__ import __version__ as version
 
 from . import console, settings, styles
 from .alias import RootTyperAliasGroup
@@ -37,7 +37,7 @@ for sub_typer in (
 def version_callback(value: bool):
     """Show the version of the CLI."""
     if value:
-        console.out.print(f'obsws-cli version: {obsws_cli_version}')
+        console.out.print(f'obsws-cli version: {version}')
         raise typer.Exit()
 
 

obsws_cli/console.py

@@ -9,4 +9,6 @@ err = Console(stderr=True, style='bold red')
 
 def highlight(ctx: typer.Context, text: str) -> str:
     """Highlight text using the current context's style."""
+    if ctx.obj['style'].name == 'no_colour':
+        return text
     return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]'

obsws_cli/filter.py

@@ -72,7 +72,7 @@ def list_(
         table.add_row(
             filter['filterName'],
             util.snakecase_to_titlecase(filter['filterKind']),
-            util.check_mark(filter['filterEnabled']),
+            util.check_mark(ctx, filter['filterEnabled']),
             '\n'.join(
                 [
                     f'{util.snakecase_to_titlecase(k):<20} {v:>10}'

obsws_cli/group.py

@@ -68,7 +68,7 @@ def list_(
         table.add_row(
             str(item_id),
             group_name,
-            util.check_mark(is_enabled),
+            util.check_mark(ctx, is_enabled),
         )
 
     console.out.print(table)

obsws_cli/input.py

@@ -81,7 +81,7 @@ def list_(
         input_mark = ''
         try:
             input_muted = ctx.obj['obsws'].get_input_mute(name=input_name).input_muted
-            input_mark = util.check_mark(input_muted)
+            input_mark = util.check_mark(ctx, input_muted)
         except obsws.error.OBSSDKRequestError as e:
             if e.code == 604:  # Input does not support audio
                 input_mark = 'N/A'

obsws_cli/profile.py

@@ -35,7 +35,9 @@ def list_(ctx: typer.Context):
     for profile in resp.profiles:
         table.add_row(
             profile,
-            util.check_mark(profile == resp.current_profile_name, empty_if_false=True),
+            util.check_mark(
+                ctx, profile == resp.current_profile_name, empty_if_false=True
+            ),
         )
 
     console.out.print(table)

obsws_cli/scene.py

@@ -50,13 +50,13 @@ def list_(
         if uuid:
             table.add_row(
                 scene_name,
-                util.check_mark(scene_name == active_scene, empty_if_false=True),
+                util.check_mark(ctx, scene_name == active_scene, empty_if_false=True),
                 scene_uuid,
             )
         else:
             table.add_row(
                 scene_name,
-                util.check_mark(scene_name == active_scene, empty_if_false=True),
+                util.check_mark(ctx, scene_name == active_scene, empty_if_false=True),
             )
 
     console.out.print(table)

obsws_cli/sceneitem.py

@@ -107,7 +107,7 @@ def list_(
                         str(group_item_id),
                         group_item_name,
                         item_name,
-                        util.check_mark(is_enabled and group_item_enabled),
+                        util.check_mark(ctx, is_enabled and group_item_enabled),
                         group_item_source_uuid,
                     )
                 else:
@@ -115,7 +115,7 @@ def list_(
                         str(group_item_id),
                         group_item_name,
                         item_name,
-                        util.check_mark(is_enabled and group_item_enabled),
+                        util.check_mark(ctx, is_enabled and group_item_enabled),
                     )
         else:
             if uuid:
@@ -123,7 +123,7 @@ def list_(
                     str(item_id),
                     item_name,
                     '',
-                    util.check_mark(is_enabled),
+                    util.check_mark(ctx, is_enabled),
                     source_uuid,
                 )
             else:
@@ -131,7 +131,7 @@ def list_(
                     str(item_id),
                     item_name,
                     '',
-                    util.check_mark(is_enabled),
+                    util.check_mark(ctx, is_enabled),
                 )
 
     console.out.print(table)

obsws_cli/util.py

@@ -2,17 +2,19 @@
 
 import os
 
+import typer
+
 
 def snakecase_to_titlecase(snake_str: str) -> str:
     """Convert a snake_case string to a title case string."""
     return snake_str.replace('_', ' ').title()
 
 
-def check_mark(value: bool, empty_if_false: bool = False) -> str:
+def check_mark(ctx: typer.Context, value: bool, empty_if_false: bool = False) -> str:
     """Return a check mark or cross mark based on the boolean value."""
     if empty_if_false and not value:
         return ''
 
-    if os.getenv('NO_COLOR', '') != '':
+    if os.getenv('NO_COLOR', '') != '' or ctx.obj['style'].name == 'no_colour':
         return '✓' if value else '✗'
     return '✅' if value else '❌'