mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-03-03 00:39:12 +00:00
Compare commits
No commits in common. "main" and "v0.24.5" have entirely different histories.
20
.github/dependabot.yml
vendored
20
.github/dependabot.yml
vendored
@ -1,20 +0,0 @@
|
||||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "github-actions" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
time: "09:00"
|
||||
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "monday"
|
||||
time: "09:00"
|
||||
4
.github/workflows/publish.yml
vendored
4
.github/workflows/publish.yml
vendored
@ -19,10 +19,10 @@ jobs:
|
||||
id-token: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v6
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
cache: 'pip'
|
||||
|
||||
2
.github/workflows/ruff.yml
vendored
2
.github/workflows/ruff.yml
vendored
@ -13,7 +13,7 @@ jobs:
|
||||
ruff:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v4
|
||||
- uses: astral-sh/ruff-action@v3
|
||||
with:
|
||||
args: 'format --check --diff'
|
||||
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
@ -5,22 +5,6 @@ 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.8] - 2026-02-07
|
||||
|
||||
### Changed
|
||||
|
||||
- --debug flag removed and replaced with --loglevel. See [Flags](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#flags). This gives the user more control over the level of logging. The default level has been set to WARNING.
|
||||
|
||||
### Fixed
|
||||
|
||||
- shell completion now works, see [Shell Completion](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#shell-completion). Unfortunately, command aliases in the help output are no longer present as it was breaking shell completion. However, the aliases do still work. See [issue #3](https://github.com/onyx-and-iris/obsws-cli/issues/3)
|
||||
|
||||
# [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
|
||||
|
||||
24
README.md
24
README.md
@ -1,6 +1,6 @@
|
||||
# obsws-cli
|
||||
|
||||
[](https://github.com/pypa/hatch)
|
||||
[](https://github.com/pypa/hatch)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
|
||||
|
||||
@ -16,7 +16,6 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
||||
- [Configuration](#configuration)
|
||||
- [Style](#style)
|
||||
- [Commands](#root-typer)
|
||||
- [Shell Completion](#shell-completion)
|
||||
- [License](#license)
|
||||
|
||||
## Requirements
|
||||
@ -49,8 +48,6 @@ The CLI should now be discoverable as `obsws-cli`
|
||||
- --password/-p: Websocket password
|
||||
- --timeout/-T: Websocket timeout
|
||||
- --version/-v: Print the obsws-cli version
|
||||
- --loglevel/-l: Set the application's logging level
|
||||
- One of *NOTSET, DEBUG, INFO, WARN, WARNING, ERROR, CRITICAL, FATAL*
|
||||
|
||||
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||
|
||||
@ -65,10 +62,9 @@ Store and load environment variables from:
|
||||
- `user home directory / .config / obsws-cli / obsws.env`
|
||||
|
||||
```env
|
||||
OBSWS_CLI_HOST=localhost
|
||||
OBSWS_CLI_PORT=4455
|
||||
OBSWS_CLI_PASSWORD=<websocket password>
|
||||
OBSWS_CLI_LOGLEVEL=DEBUG
|
||||
OBS_HOST=localhost
|
||||
OBS_PORT=4455
|
||||
OBS_PASSWORD=<websocket password>
|
||||
```
|
||||
|
||||
Flags can be used to override environment variables.
|
||||
@ -100,8 +96,8 @@ obsws-cli --style="cyan" --no-border sceneitem list
|
||||
Or with environment variables:
|
||||
|
||||
```env
|
||||
OBSWS_CLI_STYLE=cyan
|
||||
OBSWS_CLI_STYLE_NO_BORDER=true
|
||||
OBS_STYLE=cyan
|
||||
OBS_STYLE_NO_BORDER=true
|
||||
```
|
||||
|
||||
## Root Typer
|
||||
@ -818,14 +814,6 @@ obsws-cli media stop "Media"
|
||||
obsws-cli media restart "Media"
|
||||
```
|
||||
|
||||
## Shell Completion
|
||||
|
||||
```console
|
||||
obsws-cli --install-completion
|
||||
```
|
||||
|
||||
Currently supported shells: *bash* *zsh* *fish* *powershell*
|
||||
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
||||
#
|
||||
# SPDX-License-Identifier: MIT
|
||||
__version__ = '0.24.8'
|
||||
__version__ = '0.24.5'
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
"""module defining a custom group class for handling command name aliases."""
|
||||
|
||||
import re
|
||||
|
||||
import typer
|
||||
|
||||
|
||||
@ -51,3 +53,25 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
|
||||
case 'vc':
|
||||
cmd_name = 'virtualcam'
|
||||
return super().get_command(ctx, cmd_name)
|
||||
|
||||
|
||||
class SubTyperAliasGroup(typer.core.TyperGroup):
|
||||
"""A custom group class to handle command name aliases for sub typers."""
|
||||
|
||||
_CMD_SPLIT_P = re.compile(r' ?[,|] ?')
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""Initialize the AliasGroup."""
|
||||
super().__init__(*args, **kwargs)
|
||||
self.no_args_is_help = True
|
||||
|
||||
def get_command(self, ctx, cmd_name):
|
||||
"""Get a command by name."""
|
||||
cmd_name = self._group_cmd_name(cmd_name)
|
||||
return super().get_command(ctx, cmd_name)
|
||||
|
||||
def _group_cmd_name(self, default_name):
|
||||
for cmd in self.commands.values():
|
||||
if cmd.name and default_name in self._CMD_SPLIT_P.split(cmd.name):
|
||||
return cmd.name
|
||||
return default_name
|
||||
|
||||
@ -10,7 +10,7 @@ import typer
|
||||
|
||||
from obsws_cli.__about__ import __version__ as version
|
||||
|
||||
from . import commands, console, envconfig, styles
|
||||
from . import commands, config, console, styles
|
||||
from .alias import RootTyperAliasGroup
|
||||
|
||||
app = typer.Typer(cls=RootTyperAliasGroup)
|
||||
@ -28,21 +28,11 @@ def version_callback(value: bool):
|
||||
raise typer.Exit()
|
||||
|
||||
|
||||
def setup_logging(loglevel: str):
|
||||
def setup_logging(debug: bool):
|
||||
"""Set up logging for the application."""
|
||||
level_map = logging.getLevelNamesMapping()
|
||||
try:
|
||||
level_int = level_map[loglevel.upper()]
|
||||
except KeyError:
|
||||
possible_levels = ', '.join(
|
||||
sorted(level_map.keys(), key=lambda k: level_map[k])
|
||||
)
|
||||
raise typer.BadParameter(
|
||||
f'Invalid log level: {loglevel}. Valid options are: {possible_levels}'
|
||||
) from None
|
||||
|
||||
log_level = logging.DEBUG if debug else logging.CRITICAL
|
||||
logging.basicConfig(
|
||||
level=level_int,
|
||||
level=log_level,
|
||||
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
||||
)
|
||||
|
||||
@ -64,62 +54,62 @@ def main(
|
||||
typer.Option(
|
||||
'--host',
|
||||
'-H',
|
||||
envvar='OBSWS_CLI_HOST',
|
||||
envvar='OBS_HOST',
|
||||
help='WebSocket host',
|
||||
show_default='localhost',
|
||||
),
|
||||
] = envconfig.get('host'),
|
||||
] = config.get('host'),
|
||||
port: Annotated[
|
||||
int,
|
||||
typer.Option(
|
||||
'--port',
|
||||
'-P',
|
||||
envvar='OBSWS_CLI_PORT',
|
||||
envvar='OBS_PORT',
|
||||
help='WebSocket port',
|
||||
show_default=4455,
|
||||
),
|
||||
] = envconfig.get('port'),
|
||||
] = config.get('port'),
|
||||
password: Annotated[
|
||||
str,
|
||||
typer.Option(
|
||||
'--password',
|
||||
'-p',
|
||||
envvar='OBSWS_CLI_PASSWORD',
|
||||
envvar='OBS_PASSWORD',
|
||||
help='WebSocket password',
|
||||
show_default=False,
|
||||
),
|
||||
] = envconfig.get('password'),
|
||||
] = config.get('password'),
|
||||
timeout: Annotated[
|
||||
int,
|
||||
typer.Option(
|
||||
'--timeout',
|
||||
'-T',
|
||||
envvar='OBSWS_CLI_TIMEOUT',
|
||||
envvar='OBS_TIMEOUT',
|
||||
help='WebSocket timeout',
|
||||
show_default=5,
|
||||
),
|
||||
] = envconfig.get('timeout'),
|
||||
] = config.get('timeout'),
|
||||
style: Annotated[
|
||||
str,
|
||||
typer.Option(
|
||||
'--style',
|
||||
'-s',
|
||||
envvar='OBSWS_CLI_STYLE',
|
||||
envvar='OBS_STYLE',
|
||||
help='Set the style for the CLI output',
|
||||
show_default='disabled',
|
||||
callback=validate_style,
|
||||
),
|
||||
] = envconfig.get('style'),
|
||||
] = config.get('style'),
|
||||
no_border: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
'--no-border',
|
||||
'-b',
|
||||
envvar='OBSWS_CLI_STYLE_NO_BORDER',
|
||||
envvar='OBS_STYLE_NO_BORDER',
|
||||
help='Disable table border styling in the CLI output',
|
||||
show_default=False,
|
||||
),
|
||||
] = envconfig.get('style_no_border'),
|
||||
] = config.get('style_no_border'),
|
||||
version: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
@ -131,18 +121,19 @@ def main(
|
||||
callback=version_callback,
|
||||
),
|
||||
] = False,
|
||||
loglevel: Annotated[
|
||||
str,
|
||||
debug: Annotated[
|
||||
bool,
|
||||
typer.Option(
|
||||
'--loglevel',
|
||||
'-l',
|
||||
envvar='OBSWS_CLI_LOGLEVEL',
|
||||
'--debug',
|
||||
'-d',
|
||||
envvar='OBS_DEBUG',
|
||||
is_eager=True,
|
||||
help='Set the logging level',
|
||||
help='Enable debug logging',
|
||||
show_default=False,
|
||||
callback=setup_logging,
|
||||
hidden=True,
|
||||
),
|
||||
] = envconfig.get('loglevel'),
|
||||
] = config.get('debug'),
|
||||
):
|
||||
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
||||
ctx.ensure_object(dict)
|
||||
|
||||
@ -8,8 +8,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -17,8 +18,7 @@ def main():
|
||||
"""Control filters in OBS scenes."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
@ -90,8 +90,7 @@ def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
|
||||
return resp.filter_enabled
|
||||
|
||||
|
||||
@app.command('enable')
|
||||
@app.command('on', hidden=True)
|
||||
@app.command('enable | on')
|
||||
def enable(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
@ -120,8 +119,7 @@ def enable(
|
||||
)
|
||||
|
||||
|
||||
@app.command('disable')
|
||||
@app.command('off', hidden=True)
|
||||
@app.command('disable | off')
|
||||
def disable(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
@ -150,8 +148,7 @@ def disable(
|
||||
)
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
@ -184,8 +181,7 @@ def toggle(
|
||||
)
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
|
||||
@ -7,9 +7,10 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
from obsws_cli.protocols import DataclassProtocol
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -17,8 +18,7 @@ def main():
|
||||
"""Control groups in OBS scenes."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -84,8 +84,7 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
||||
return group
|
||||
|
||||
|
||||
@app.command('show')
|
||||
@app.command('sh', hidden=True)
|
||||
@app.command('show | sh')
|
||||
def show(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -118,8 +117,7 @@ def show(
|
||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||
|
||||
|
||||
@app.command('hide')
|
||||
@app.command('h', hidden=True)
|
||||
@app.command('hide | h')
|
||||
def hide(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -152,8 +150,7 @@ def hide(
|
||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -190,8 +187,7 @@ def toggle(
|
||||
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
|
||||
@ -7,8 +7,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Control hotkeys in OBS."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
):
|
||||
@ -45,8 +45,7 @@ def list_(
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('trigger')
|
||||
@app.command('tr', hidden=True)
|
||||
@app.command('trigger | tr')
|
||||
def trigger(
|
||||
ctx: typer.Context,
|
||||
hotkey: Annotated[
|
||||
@ -57,8 +56,7 @@ def trigger(
|
||||
ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
|
||||
|
||||
|
||||
@app.command('trigger-sequence')
|
||||
@app.command('trs', hidden=True)
|
||||
@app.command('trigger-sequence | trs')
|
||||
def trigger_sequence(
|
||||
ctx: typer.Context,
|
||||
key_id: Annotated[
|
||||
|
||||
@ -8,8 +8,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -17,8 +18,7 @@ def main():
|
||||
"""Control inputs in OBS."""
|
||||
|
||||
|
||||
@app.command('create')
|
||||
@app.command('cr', hidden=True)
|
||||
@app.command('create | add')
|
||||
def create(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -62,8 +62,7 @@ def create(
|
||||
)
|
||||
|
||||
|
||||
@app.command('remove')
|
||||
@app.command('rm', hidden=True)
|
||||
@app.command('remove | rm')
|
||||
def remove(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -82,8 +81,7 @@ def remove(
|
||||
console.out.print(f'Input {console.highlight(ctx, input_name)} removed.')
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
|
||||
@ -170,8 +168,7 @@ def list_(
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('list-kinds')
|
||||
@app.command('ls-k', hidden=True)
|
||||
@app.command('list-kinds | ls-k')
|
||||
def list_kinds(
|
||||
ctx: typer.Context,
|
||||
):
|
||||
@ -198,8 +195,7 @@ def list_kinds(
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('mute')
|
||||
@app.command('m', hidden=True)
|
||||
@app.command('mute | m')
|
||||
def mute(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -221,8 +217,7 @@ def mute(
|
||||
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
|
||||
|
||||
|
||||
@app.command('unmute')
|
||||
@app.command('um', hidden=True)
|
||||
@app.command('unmute | um')
|
||||
def unmute(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -244,8 +239,7 @@ def unmute(
|
||||
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -277,8 +271,7 @@ def toggle(
|
||||
)
|
||||
|
||||
|
||||
@app.command('volume')
|
||||
@app.command('vol', hidden=True)
|
||||
@app.command('volume | vol')
|
||||
def volume(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -312,8 +305,7 @@ def volume(
|
||||
)
|
||||
|
||||
|
||||
@app.command('show')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('show | s')
|
||||
def show(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -406,8 +398,7 @@ def show(
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('update')
|
||||
@app.command('upd', hidden=True)
|
||||
@app.command('update | upd')
|
||||
def update(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
|
||||
@ -5,8 +5,9 @@ from typing import Annotated, Optional
|
||||
import typer
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -14,8 +15,7 @@ def main():
|
||||
"""Commands for media inputs."""
|
||||
|
||||
|
||||
@app.command('cursor')
|
||||
@app.command('cur', hidden=True)
|
||||
@app.command('cursor | c')
|
||||
def cursor(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -45,8 +45,7 @@ def cursor(
|
||||
)
|
||||
|
||||
|
||||
@app.command('play')
|
||||
@app.command('p', hidden=True)
|
||||
@app.command('play | p')
|
||||
def play(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -60,8 +59,7 @@ def play(
|
||||
console.out.print(f'Playing media input {console.highlight(ctx, input_name)}.')
|
||||
|
||||
|
||||
@app.command('pause')
|
||||
@app.command('pa', hidden=True)
|
||||
@app.command('pause | pa')
|
||||
def pause(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -75,8 +73,7 @@ def pause(
|
||||
console.out.print(f'Paused media input {console.highlight(ctx, input_name)}.')
|
||||
|
||||
|
||||
@app.command('stop')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('stop | s')
|
||||
def stop(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -90,8 +87,7 @@ def stop(
|
||||
console.out.print(f'Stopped media input {console.highlight(ctx, input_name)}.')
|
||||
|
||||
|
||||
@app.command('restart')
|
||||
@app.command('r', hidden=True)
|
||||
@app.command('restart | r')
|
||||
def restart(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
|
||||
@ -7,8 +7,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Control profiles in OBS."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(ctx: typer.Context):
|
||||
"""List profiles."""
|
||||
resp = ctx.obj['obsws'].get_profile_list()
|
||||
@ -47,8 +47,7 @@ def list_(ctx: typer.Context):
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('current')
|
||||
@app.command('get', hidden=True)
|
||||
@app.command('current | get')
|
||||
def current(ctx: typer.Context):
|
||||
"""Get the current profile."""
|
||||
resp = ctx.obj['obsws'].get_profile_list()
|
||||
@ -57,8 +56,7 @@ def current(ctx: typer.Context):
|
||||
)
|
||||
|
||||
|
||||
@app.command('switch')
|
||||
@app.command('set', hidden=True)
|
||||
@app.command('switch | set')
|
||||
def switch(
|
||||
ctx: typer.Context,
|
||||
profile_name: Annotated[
|
||||
@ -83,8 +81,7 @@ def switch(
|
||||
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
|
||||
|
||||
|
||||
@app.command('create')
|
||||
@app.command('new', hidden=True)
|
||||
@app.command('create | new')
|
||||
def create(
|
||||
ctx: typer.Context,
|
||||
profile_name: Annotated[
|
||||
@ -102,8 +99,7 @@ def create(
|
||||
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
|
||||
|
||||
|
||||
@app.command('remove')
|
||||
@app.command('rm', hidden=True)
|
||||
@app.command('remove | rm')
|
||||
def remove(
|
||||
ctx: typer.Context,
|
||||
profile_name: Annotated[
|
||||
|
||||
@ -7,8 +7,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Control projectors in OBS."""
|
||||
|
||||
|
||||
@app.command('list-monitors')
|
||||
@app.command('ls-m', hidden=True)
|
||||
@app.command('list-monitors | ls-m')
|
||||
def list_monitors(ctx: typer.Context):
|
||||
"""List available monitors."""
|
||||
resp = ctx.obj['obsws'].get_monitor_list()
|
||||
@ -48,8 +48,7 @@ def list_monitors(ctx: typer.Context):
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('open')
|
||||
@app.command('o', hidden=True)
|
||||
@app.command('open | o')
|
||||
def open(
|
||||
ctx: typer.Context,
|
||||
monitor_index: Annotated[
|
||||
|
||||
@ -6,8 +6,9 @@ from typing import Annotated, Optional
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -21,8 +22,7 @@ def _get_recording_status(ctx: typer.Context) -> tuple:
|
||||
return resp.output_active, resp.output_paused
|
||||
|
||||
|
||||
@app.command('start')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('start | s')
|
||||
def start(ctx: typer.Context):
|
||||
"""Start recording."""
|
||||
active, paused = _get_recording_status(ctx)
|
||||
@ -38,8 +38,7 @@ def start(ctx: typer.Context):
|
||||
console.out.print('Recording started successfully.')
|
||||
|
||||
|
||||
@app.command('stop')
|
||||
@app.command('st', hidden=True)
|
||||
@app.command('stop | st')
|
||||
def stop(ctx: typer.Context):
|
||||
"""Stop recording."""
|
||||
active, _ = _get_recording_status(ctx)
|
||||
@ -53,8 +52,7 @@ def stop(ctx: typer.Context):
|
||||
)
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(ctx: typer.Context):
|
||||
"""Toggle recording."""
|
||||
resp = ctx.obj['obsws'].toggle_record()
|
||||
@ -64,8 +62,7 @@ def toggle(ctx: typer.Context):
|
||||
console.out.print('Recording stopped successfully.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(ctx: typer.Context):
|
||||
"""Get recording status."""
|
||||
active, paused = _get_recording_status(ctx)
|
||||
@ -78,8 +75,7 @@ def status(ctx: typer.Context):
|
||||
console.out.print('Recording is not in progress.')
|
||||
|
||||
|
||||
@app.command('resume')
|
||||
@app.command('r', hidden=True)
|
||||
@app.command('resume | r')
|
||||
def resume(ctx: typer.Context):
|
||||
"""Resume recording."""
|
||||
active, paused = _get_recording_status(ctx)
|
||||
@ -94,8 +90,7 @@ def resume(ctx: typer.Context):
|
||||
console.out.print('Recording resumed successfully.')
|
||||
|
||||
|
||||
@app.command('pause')
|
||||
@app.command('p', hidden=True)
|
||||
@app.command('pause | p')
|
||||
def pause(ctx: typer.Context):
|
||||
"""Pause recording."""
|
||||
active, paused = _get_recording_status(ctx)
|
||||
@ -110,8 +105,7 @@ def pause(ctx: typer.Context):
|
||||
console.out.print('Recording paused successfully.')
|
||||
|
||||
|
||||
@app.command('directory')
|
||||
@app.command('d', hidden=True)
|
||||
@app.command('directory | d')
|
||||
def directory(
|
||||
ctx: typer.Context,
|
||||
record_directory: Annotated[
|
||||
@ -138,8 +132,7 @@ def directory(
|
||||
)
|
||||
|
||||
|
||||
@app.command('split')
|
||||
@app.command('sp', hidden=True)
|
||||
@app.command('split | sp')
|
||||
def split(ctx: typer.Context):
|
||||
"""Split the current recording."""
|
||||
active, paused = _get_recording_status(ctx)
|
||||
@ -154,8 +147,7 @@ def split(ctx: typer.Context):
|
||||
console.out.print('Recording split successfully.')
|
||||
|
||||
|
||||
@app.command('chapter')
|
||||
@app.command('ch', hidden=True)
|
||||
@app.command('chapter | ch')
|
||||
def chapter(
|
||||
ctx: typer.Context,
|
||||
chapter_name: Annotated[
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -12,8 +13,7 @@ def main():
|
||||
"""Control profiles in OBS."""
|
||||
|
||||
|
||||
@app.command('start')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('start | s')
|
||||
def start(ctx: typer.Context):
|
||||
"""Start the replay buffer."""
|
||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||
@ -25,8 +25,7 @@ def start(ctx: typer.Context):
|
||||
console.out.print('Replay buffer started.')
|
||||
|
||||
|
||||
@app.command('stop')
|
||||
@app.command('st', hidden=True)
|
||||
@app.command('stop | st')
|
||||
def stop(ctx: typer.Context):
|
||||
"""Stop the replay buffer."""
|
||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||
@ -38,8 +37,7 @@ def stop(ctx: typer.Context):
|
||||
console.out.print('Replay buffer stopped.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(ctx: typer.Context):
|
||||
"""Toggle the replay buffer."""
|
||||
resp = ctx.obj['obsws'].toggle_replay_buffer()
|
||||
@ -49,8 +47,7 @@ def toggle(ctx: typer.Context):
|
||||
console.out.print('Replay buffer is not active.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(ctx: typer.Context):
|
||||
"""Get the status of the replay buffer."""
|
||||
resp = ctx.obj['obsws'].get_replay_buffer_status()
|
||||
@ -60,8 +57,7 @@ def status(ctx: typer.Context):
|
||||
console.out.print('Replay buffer is not active.')
|
||||
|
||||
|
||||
@app.command('save')
|
||||
@app.command('sv', hidden=True)
|
||||
@app.command('save | sv')
|
||||
def save(ctx: typer.Context):
|
||||
"""Save the replay buffer."""
|
||||
ctx.obj['obsws'].save_replay_buffer()
|
||||
|
||||
@ -7,8 +7,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Control OBS scenes."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
|
||||
@ -66,8 +66,7 @@ def list_(
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('current')
|
||||
@app.command('get', hidden=True)
|
||||
@app.command('current | get')
|
||||
def current(
|
||||
ctx: typer.Context,
|
||||
preview: Annotated[
|
||||
@ -91,8 +90,7 @@ def current(
|
||||
)
|
||||
|
||||
|
||||
@app.command('switch')
|
||||
@app.command('set', hidden=True)
|
||||
@app.command('switch | set')
|
||||
def switch(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
|
||||
@ -6,8 +6,9 @@ import typer
|
||||
from rich.table import Table
|
||||
|
||||
from obsws_cli import console, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -15,8 +16,7 @@ def main():
|
||||
"""Control scene collections in OBS."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(ctx: typer.Context):
|
||||
"""List all scene collections."""
|
||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||
@ -40,8 +40,7 @@ def list_(ctx: typer.Context):
|
||||
console.out.print(table)
|
||||
|
||||
|
||||
@app.command('current')
|
||||
@app.command('get', hidden=True)
|
||||
@app.command('current | get')
|
||||
def current(ctx: typer.Context):
|
||||
"""Get the current scene collection."""
|
||||
resp = ctx.obj['obsws'].get_scene_collection_list()
|
||||
@ -50,8 +49,7 @@ def current(ctx: typer.Context):
|
||||
)
|
||||
|
||||
|
||||
@app.command('switch')
|
||||
@app.command('set', hidden=True)
|
||||
@app.command('switch | set')
|
||||
def switch(
|
||||
ctx: typer.Context,
|
||||
scene_collection_name: Annotated[
|
||||
@ -79,8 +77,7 @@ def switch(
|
||||
)
|
||||
|
||||
|
||||
@app.command('create')
|
||||
@app.command('new', hidden=True)
|
||||
@app.command('create | new')
|
||||
def create(
|
||||
ctx: typer.Context,
|
||||
scene_collection_name: Annotated[
|
||||
|
||||
@ -6,8 +6,9 @@ import typer
|
||||
from rich.table import Table
|
||||
|
||||
from obsws_cli import console, util, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -15,8 +16,7 @@ def main():
|
||||
"""Control items in OBS scenes."""
|
||||
|
||||
|
||||
@app.command('list')
|
||||
@app.command('ls', hidden=True)
|
||||
@app.command('list | ls')
|
||||
def list_(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -186,8 +186,7 @@ def _get_scene_name_and_item_id(
|
||||
return scene_name, scene_item_id
|
||||
|
||||
|
||||
@app.command('show')
|
||||
@app.command('sh', hidden=True)
|
||||
@app.command('show | sh')
|
||||
def show(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -229,8 +228,7 @@ def show(
|
||||
)
|
||||
|
||||
|
||||
@app.command('hide')
|
||||
@app.command('h', hidden=True)
|
||||
@app.command('hide | h')
|
||||
def hide(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -271,8 +269,7 @@ def hide(
|
||||
)
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -333,8 +330,7 @@ def toggle(
|
||||
)
|
||||
|
||||
|
||||
@app.command('visible')
|
||||
@app.command('v', hidden=True)
|
||||
@app.command('visible | v')
|
||||
def visible(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
@ -378,8 +374,7 @@ def visible(
|
||||
)
|
||||
|
||||
|
||||
@app.command('transform')
|
||||
@app.command('t', hidden=True)
|
||||
@app.command('transform | t')
|
||||
def transform(
|
||||
ctx: typer.Context,
|
||||
scene_name: Annotated[
|
||||
|
||||
@ -7,8 +7,9 @@ import obsws_python as obsws
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Take screenshots using OBS."""
|
||||
|
||||
|
||||
@app.command('save')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('save | sv')
|
||||
def save(
|
||||
ctx: typer.Context,
|
||||
source_name: Annotated[
|
||||
|
||||
@ -7,8 +7,9 @@ from rich.table import Table
|
||||
from rich.text import Text
|
||||
|
||||
from obsws_cli import console, util
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -16,8 +17,7 @@ def main():
|
||||
"""Manage OBS settings."""
|
||||
|
||||
|
||||
@app.command('show')
|
||||
@app.command('sh', hidden=True)
|
||||
@app.command('show | sh')
|
||||
def show(
|
||||
ctx: typer.Context,
|
||||
video: Annotated[
|
||||
@ -136,8 +136,7 @@ def show(
|
||||
console.out.print(profile_table)
|
||||
|
||||
|
||||
@app.command('profile')
|
||||
@app.command('pr', hidden=True)
|
||||
@app.command('profile | pr')
|
||||
def profile(
|
||||
ctx: typer.Context,
|
||||
category: Annotated[
|
||||
@ -183,8 +182,7 @@ def profile(
|
||||
)
|
||||
|
||||
|
||||
@app.command('stream-service')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('stream-service | ss')
|
||||
def stream_service(
|
||||
ctx: typer.Context,
|
||||
type_: Annotated[
|
||||
@ -251,8 +249,7 @@ def stream_service(
|
||||
console.out.print('Stream service settings updated.')
|
||||
|
||||
|
||||
@app.command('video')
|
||||
@app.command('vi', hidden=True)
|
||||
@app.command('video | vi')
|
||||
def video(
|
||||
ctx: typer.Context,
|
||||
base_width: Annotated[
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -18,8 +19,7 @@ def _get_streaming_status(ctx: typer.Context) -> tuple:
|
||||
return resp.output_active, resp.output_duration
|
||||
|
||||
|
||||
@app.command('start')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('start | s')
|
||||
def start(ctx: typer.Context):
|
||||
"""Start streaming."""
|
||||
active, _ = _get_streaming_status(ctx)
|
||||
@ -31,8 +31,7 @@ def start(ctx: typer.Context):
|
||||
console.out.print('Streaming started successfully.')
|
||||
|
||||
|
||||
@app.command('stop')
|
||||
@app.command('st', hidden=True)
|
||||
@app.command('stop | st')
|
||||
def stop(ctx: typer.Context):
|
||||
"""Stop streaming."""
|
||||
active, _ = _get_streaming_status(ctx)
|
||||
@ -44,8 +43,7 @@ def stop(ctx: typer.Context):
|
||||
console.out.print('Streaming stopped successfully.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(ctx: typer.Context):
|
||||
"""Toggle streaming."""
|
||||
resp = ctx.obj['obsws'].toggle_stream()
|
||||
@ -55,8 +53,7 @@ def toggle(ctx: typer.Context):
|
||||
console.out.print('Streaming stopped successfully.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(ctx: typer.Context):
|
||||
"""Get streaming status."""
|
||||
active, duration = _get_streaming_status(ctx)
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -12,24 +13,21 @@ def main():
|
||||
"""Control studio mode in OBS."""
|
||||
|
||||
|
||||
@app.command('enable')
|
||||
@app.command('on', hidden=True)
|
||||
@app.command('enable | on')
|
||||
def enable(ctx: typer.Context):
|
||||
"""Enable studio mode."""
|
||||
ctx.obj['obsws'].set_studio_mode_enabled(True)
|
||||
console.out.print('Studio mode has been enabled.')
|
||||
|
||||
|
||||
@app.command('disable')
|
||||
@app.command('off', hidden=True)
|
||||
@app.command('disable | off')
|
||||
def disable(ctx: typer.Context):
|
||||
"""Disable studio mode."""
|
||||
ctx.obj['obsws'].set_studio_mode_enabled(False)
|
||||
console.out.print('Studio mode has been disabled.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(ctx: typer.Context):
|
||||
"""Toggle studio mode."""
|
||||
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||
@ -41,8 +39,7 @@ def toggle(ctx: typer.Context):
|
||||
console.out.print('Studio mode is now enabled.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(ctx: typer.Context):
|
||||
"""Get the status of studio mode."""
|
||||
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||
|
||||
@ -5,8 +5,9 @@ from typing import Annotated, Optional
|
||||
import typer
|
||||
|
||||
from obsws_cli import console, validate
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -14,8 +15,7 @@ def main():
|
||||
"""Control text inputs in OBS."""
|
||||
|
||||
|
||||
@app.command('current')
|
||||
@app.command('get', hidden=True)
|
||||
@app.command('current | get')
|
||||
def current(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
@ -41,8 +41,7 @@ def current(
|
||||
)
|
||||
|
||||
|
||||
@app.command('update')
|
||||
@app.command('set', hidden=True)
|
||||
@app.command('update | set')
|
||||
def update(
|
||||
ctx: typer.Context,
|
||||
input_name: Annotated[
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
import typer
|
||||
|
||||
from obsws_cli import console
|
||||
from obsws_cli.alias import SubTyperAliasGroup
|
||||
|
||||
app = typer.Typer()
|
||||
app = typer.Typer(cls=SubTyperAliasGroup)
|
||||
|
||||
|
||||
@app.callback()
|
||||
@ -12,24 +13,21 @@ def main():
|
||||
"""Control virtual camera in OBS."""
|
||||
|
||||
|
||||
@app.command('start')
|
||||
@app.command('s', hidden=True)
|
||||
@app.command('start | s')
|
||||
def start(ctx: typer.Context):
|
||||
"""Start the virtual camera."""
|
||||
ctx.obj['obsws'].start_virtual_cam()
|
||||
console.out.print('Virtual camera started.')
|
||||
|
||||
|
||||
@app.command('stop')
|
||||
@app.command('p', hidden=True)
|
||||
@app.command('stop | p')
|
||||
def stop(ctx: typer.Context):
|
||||
"""Stop the virtual camera."""
|
||||
ctx.obj['obsws'].stop_virtual_cam()
|
||||
console.out.print('Virtual camera stopped.')
|
||||
|
||||
|
||||
@app.command('toggle')
|
||||
@app.command('tg', hidden=True)
|
||||
@app.command('toggle | tg')
|
||||
def toggle(ctx: typer.Context):
|
||||
"""Toggle the virtual camera."""
|
||||
resp = ctx.obj['obsws'].toggle_virtual_cam()
|
||||
@ -39,8 +37,7 @@ def toggle(ctx: typer.Context):
|
||||
console.out.print('Virtual camera is disabled.')
|
||||
|
||||
|
||||
@app.command('status')
|
||||
@app.command('ss', hidden=True)
|
||||
@app.command('status | ss')
|
||||
def status(ctx: typer.Context):
|
||||
"""Get the status of the virtual camera."""
|
||||
resp = ctx.obj['obsws'].get_virtual_cam_status()
|
||||
|
||||
80
obsws_cli/config.py
Normal file
80
obsws_cli/config.py
Normal file
@ -0,0 +1,80 @@
|
||||
"""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]
|
||||
@ -1,146 +0,0 @@
|
||||
"""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_LOGLEVEL='WARNING',
|
||||
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)
|
||||
@ -35,9 +35,6 @@ obsws-cli = "obsws_cli:app"
|
||||
[tool.hatch.version]
|
||||
path = "obsws_cli/__about__.py"
|
||||
|
||||
[tool.hatch.env]
|
||||
requires = ["hatch-dotenv"]
|
||||
|
||||
[tool.hatch.envs.default]
|
||||
dependencies = ["click-man>=0.5.1"]
|
||||
|
||||
@ -48,10 +45,6 @@ man = "python man/generate.py --output=./man"
|
||||
[tool.hatch.envs.hatch-test]
|
||||
randomize = true
|
||||
|
||||
[tool.hatch.env.collectors.dotenv.hatch-test]
|
||||
env-files = [".env", ".test.env"]
|
||||
fail-on-missing = true
|
||||
|
||||
[tool.hatch.envs.types]
|
||||
extra-dependencies = ["mypy>=1.0.0"]
|
||||
[tool.hatch.envs.types.scripts]
|
||||
|
||||
@ -4,6 +4,7 @@ import os
|
||||
import time
|
||||
|
||||
import obsws_python as obsws
|
||||
from dotenv import find_dotenv, load_dotenv
|
||||
|
||||
|
||||
def pytest_configure(config):
|
||||
@ -20,9 +21,9 @@ def pytest_sessionstart(session):
|
||||
"""
|
||||
# Initialize the OBS WebSocket client
|
||||
session.obsws = obsws.ReqClient(
|
||||
host=os.environ['OBSWS_CLI_HOST'],
|
||||
port=os.environ['OBSWS_CLI_PORT'],
|
||||
password=os.environ['OBSWS_CLI_PASSWORD'],
|
||||
host=os.environ['OBS_HOST'],
|
||||
port=os.environ['OBS_PORT'],
|
||||
password=os.environ['OBS_PASSWORD'],
|
||||
timeout=5,
|
||||
)
|
||||
resp = session.obsws.get_version()
|
||||
@ -33,12 +34,14 @@ 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['OBSWS_CLI_TESTS_STREAM_KEY'],
|
||||
'key': os.environ['OBS_STREAM_KEY'],
|
||||
},
|
||||
)
|
||||
|
||||
@ -60,7 +63,7 @@ def pytest_sessionstart(session):
|
||||
'linux': 'pulse_output_capture',
|
||||
'darwin': 'coreaudio_output_capture',
|
||||
}
|
||||
platform = os.environ['OBSWS_CLI_TESTS_PLATFORM']
|
||||
platform = os.environ.get('OBS_TESTS_PLATFORM', os.uname().sysname.lower())
|
||||
try:
|
||||
session.obsws.create_input(
|
||||
sceneName='pytest_scene',
|
||||
|
||||
@ -9,7 +9,7 @@ from obsws_cli.app import app
|
||||
|
||||
runner = CliRunner()
|
||||
|
||||
if os.environ.get('OBSWS_CLI_TESTS_SKIP_GROUP_TESTS'):
|
||||
if os.environ.get('OBS_TESTS_SKIP_GROUP_TESTS'):
|
||||
pytest.skip(
|
||||
'Skipping group tests as per environment variable', allow_module_level=True
|
||||
)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user