mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-21 00:13:38 +00:00
Compare commits
121 Commits
3dbff1cc4d
...
switch-to-
| Author | SHA1 | Date | |
|---|---|---|---|
| 23e358da9c | |||
| 417ad54a0c | |||
| 3b184c6531 | |||
| 8c37ce1fc0 | |||
| 436e4d5345 | |||
| 2ef89be184 | |||
| 506aff833c | |||
| eb939b735c | |||
| bb7a468dd5 | |||
| e77627b845 | |||
| 93b066090b | |||
| 1ce832dfde | |||
| e8664f0117 | |||
| a3dff0f739 | |||
| 6da9df5ceb | |||
| 75fc18273e | |||
| e658819719 | |||
| 4451fbf22c | |||
| 132b283347 | |||
| ae8ff20cf4 | |||
| de1c604c46 | |||
| 105aaf29b7 | |||
| eb34a1833f | |||
| abbab5c746 | |||
| f0eb518609 | |||
| 032b957670 | |||
| 8349a196e8 | |||
| f852a733c3 | |||
| 44dadcee23 | |||
| ed4531c305 | |||
| ec42a4cdd9 | |||
| 6123c92d00 | |||
| 1ceb95ab16 | |||
| f06e2d3982 | |||
| 39dff3cc28 | |||
| 967c4ab699 | |||
| dc128720c7 | |||
| 2e3f4267cd | |||
| 000431ab82 | |||
| ec3e31cc4f | |||
| cda0bbedb9 | |||
| d0c96b853d | |||
| 040a41daa7 | |||
| 0c72a10fb7 | |||
| f882302d16 | |||
| 98e0d98cc7 | |||
| c6b22c7cf2 | |||
| c3e55200db | |||
| 4d37714aaf | |||
| 157e1a167c | |||
| d628c5d3a4 | |||
| 4bf8edb692 | |||
| d68326f37a | |||
| a001455dad | |||
| 4632260961 | |||
| 55a7da67db | |||
| 7bec573ef9 | |||
| 55e60ff977 | |||
| 922efddf7a | |||
| 4a0147aa8a | |||
| cec76df1d1 | |||
| 2e5fb3800a | |||
| 3c985f5e9b | |||
| fb17979cb0 | |||
| a1ed208bdf | |||
| 02baa13dba | |||
| 7abbccae99 | |||
| 23282a60d1 | |||
| b6ba66db64 | |||
| c4480895a1 | |||
| fd2e629ec2 | |||
| 85b653891d | |||
| bff5d396a4 | |||
| 47324597d7 | |||
| 9a0659ae35 | |||
| a726f9699f | |||
| fbea2cb896 | |||
| e5040d5ddd | |||
| 39f1b01926 | |||
| e9b3106aa6 | |||
| a26ce74151 | |||
| f1c569f140 | |||
| 093e9a05d4 | |||
| 1a1fbf1da1 | |||
| fd2baf3350 | |||
| 5334879ba9 | |||
| 77dbe52ae6 | |||
| 1ff610410a | |||
| cd7614bfd6 | |||
| 74503f17e0 | |||
| 32bc4277f2 | |||
| 21f1b5e1bb | |||
| 434f8c0e0c | |||
| 81518a14ea | |||
| ddb92bb317 | |||
| 44527b35e2 | |||
| 0bcfc2ae14 | |||
| ab71414d27 | |||
| ab0679174b | |||
| 37781f6de7 | |||
| 5e84becc57 | |||
| b8dd94ccbc | |||
| 657fa84ea3 | |||
| 59f52417cd | |||
| 2d351e00b5 | |||
| 5f606b42d0 | |||
| ae4ec542aa | |||
| 6ac63aa5e8 | |||
| df90614352 | |||
| d8e89285cc | |||
| 3e2a1e4663 | |||
| 723d79e306 | |||
| 868d40ec8d | |||
| 30f19f4d87 | |||
| 5b9dd97167 | |||
| d41ad994b7 | |||
| 51a4a60aa6 | |||
| 3bf20a06d6 | |||
| 653bdb7de7 | |||
| 8a04303af7 | |||
| 7b94ca2d7d |
39
.github/workflows/publish.yml
vendored
Normal file
39
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: Publish to PyPI
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*.*.*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
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
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
cache: 'pip'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install hatch
|
||||||
|
|
||||||
|
- name: Build package
|
||||||
|
run: hatch build
|
||||||
|
|
||||||
|
- name: Publish on PyPI
|
||||||
|
uses: pypa/gh-action-pypi-publish@release/v1
|
||||||
19
.github/workflows/ruff.yml
vendored
Normal file
19
.github/workflows/ruff.yml
vendored
Normal file
@@ -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'
|
||||||
75
CHANGELOG.md
75
CHANGELOG.md
@@ -5,11 +5,84 @@ 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/),
|
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).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
# [0.20.0] - 2025-07-14
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- text command group, see [Text](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#text)
|
||||||
|
|
||||||
|
# [0.19.0] - 2025-06-23
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- record split and record chapter commands, see [Record](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#record)
|
||||||
|
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
|
||||||
|
|
||||||
|
# [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
|
||||||
|
|
||||||
|
- input list, scene list and sceneitem list now accept --uuid flag.
|
||||||
|
- Active column added to scene list table.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- scene list no longer prints the UUIDs by default, enable it with the --uuid flag.
|
||||||
|
- if NO_COLOR is set, print colourless check and cross marks in tables.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Issue with input list not printing all inputs if no filters were applied.
|
||||||
|
|
||||||
|
# [0.16.8] - 2025-06-07
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- filter list:
|
||||||
|
- --ffmpeg, --vlc flags
|
||||||
|
- Muted column to list table
|
||||||
|
|
||||||
|
# [0.16.5] - 2025-06-06
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- [Disable Colouring](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#disable-colouring) section added to README.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- error output:
|
||||||
|
- now printed in bold red.
|
||||||
|
- highlights are now yellow
|
||||||
|
- normal output:
|
||||||
|
- highlights are now green
|
||||||
|
- help messages:
|
||||||
|
- removed a lot of the `[default: None]`, this affects optional flags/arguments without default values.
|
||||||
|
|
||||||
|
# [0.16.1] - 2025-06-04
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- screenshot save command, see [Screenshot](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#screenshot)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- filter list:
|
||||||
|
- source_name arg is now optional, it defaults to the current scene.
|
||||||
|
- default values are printed if unmodified.
|
||||||
|
|
||||||
# [0.15.0] - 2025-06-02
|
# [0.15.0] - 2025-06-02
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- root typer now accepts --version/-v option, it returns the CLI version. See [Root Typer](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#root-typer)
|
- root typer now accepts --version/-v option, it returns the CLI version. See [Flags](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#flags)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
|||||||
108
README.md
108
README.md
@@ -14,6 +14,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
|
- [Style](#style)
|
||||||
- [Commands](#root-typer)
|
- [Commands](#root-typer)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
@@ -42,7 +43,13 @@ The CLI should now be discoverable as `obsws-cli`
|
|||||||
|
|
||||||
#### Flags
|
#### Flags
|
||||||
|
|
||||||
Pass `--host`, `--port` and `--password` as flags to the root command, for example:
|
- --host/-H: Websocket host
|
||||||
|
- --port/-P Websocket port
|
||||||
|
- --password/-p: Websocket password
|
||||||
|
- --timeout/-T: Websocket timeout
|
||||||
|
- --version/-v: Print the obsws-cli version
|
||||||
|
|
||||||
|
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli --host=localhost --port=4455 --password=<websocket password> --help
|
obsws-cli --host=localhost --port=4455 --password=<websocket password> --help
|
||||||
@@ -62,14 +69,39 @@ OBS_PASSWORD=<websocket password>
|
|||||||
|
|
||||||
Flags can be used to override environment variables.
|
Flags can be used to override environment variables.
|
||||||
|
|
||||||
## Root Typer
|
## Style
|
||||||
|
|
||||||
- --version/-v: Get the obsws-cli version:
|
Styling is opt-in, by default you will get a colourless output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You may enable styling with the --style/-s flag:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli --version
|
obsws-cli --style="cyan" sceneitem list
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Optionally you may disable border colouring with the --no-border flag:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli --style="cyan" --no-border sceneitem list
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with environment variables:
|
||||||
|
|
||||||
|
```env
|
||||||
|
OBS_STYLE=cyan
|
||||||
|
OBS_STYLE_NO_BORDER=true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Root Typer
|
||||||
|
|
||||||
- obs-version: Get the OBS Client and WebSocket versions.
|
- obs-version: Get the OBS Client and WebSocket versions.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@@ -81,6 +113,10 @@ obsws-cli obs-version
|
|||||||
#### Scene
|
#### Scene
|
||||||
|
|
||||||
- list: List all scenes.
|
- list: List all scenes.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --uuid: Show UUIDs of scenes
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli scene list
|
obsws-cli scene list
|
||||||
@@ -102,6 +138,10 @@ obsws-cli scene switch LIVE
|
|||||||
#### Scene Item
|
#### Scene Item
|
||||||
|
|
||||||
- list: List all items in a scene.
|
- list: List all items in a scene.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --uuid: Show UUIDs of scene items
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- args: <scene_name>
|
- args: <scene_name>
|
||||||
@@ -265,6 +305,9 @@ obsws-cli group status START "test_group"
|
|||||||
- --input: Filter by input type.
|
- --input: Filter by input type.
|
||||||
- --output: Filter by output type.
|
- --output: Filter by output type.
|
||||||
- --colour: Filter by colour source type.
|
- --colour: Filter by colour source type.
|
||||||
|
- --ffmpeg: Filter by ffmpeg source type.
|
||||||
|
- --vlc: Filter by VLC source type.
|
||||||
|
- --uuid: Show UUIDs of inputs.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli input list
|
obsws-cli input list
|
||||||
@@ -292,6 +335,22 @@ obsws-cli input unmute "Mic/Aux"
|
|||||||
obsws-cli input toggle "Mic/Aux"
|
obsws-cli input toggle "Mic/Aux"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Text
|
||||||
|
|
||||||
|
- current: Get the current text for a text input.
|
||||||
|
- args: <input_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli text current "My Text Input"
|
||||||
|
```
|
||||||
|
|
||||||
|
- update: Update the text of a text input.
|
||||||
|
- args: <input_name> <new_text>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli text update "My Text Input" "hi OBS!"
|
||||||
|
```
|
||||||
|
|
||||||
#### Record
|
#### Record
|
||||||
|
|
||||||
- start: Start recording.
|
- start: Start recording.
|
||||||
@@ -343,6 +402,21 @@ obsws-cli record directory "/home/me/obs-vids/"
|
|||||||
obsws-cli record directory "C:/Users/me/Videos"
|
obsws-cli record directory "C:/Users/me/Videos"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- split: Split the current recording.
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli record split
|
||||||
|
```
|
||||||
|
|
||||||
|
- chapter: Create a chapter in the current recording.
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: <chapter_name>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli record chapter "Chapter Name"
|
||||||
|
```
|
||||||
|
|
||||||
#### Stream
|
#### Stream
|
||||||
|
|
||||||
- start: Start streaming.
|
- start: Start streaming.
|
||||||
@@ -519,7 +593,10 @@ obsws-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
|
|||||||
#### Filter
|
#### Filter
|
||||||
|
|
||||||
- list: List filters for a source.
|
- list: List filters for a source.
|
||||||
|
|
||||||
|
*optional*
|
||||||
- args: <source_name>
|
- args: <source_name>
|
||||||
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli filter list "Mic/Aux"
|
obsws-cli filter list "Mic/Aux"
|
||||||
@@ -573,13 +650,31 @@ obsws-cli projector list-monitors
|
|||||||
- defaults to current scene
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
obsws-cli project open
|
obsws-cli projector open
|
||||||
|
|
||||||
obsws-cli projector open --monitor-index=1 "test_scene"
|
obsws-cli projector open --monitor-index=1 "test_scene"
|
||||||
|
|
||||||
obsws-cli projector open --monitor-index=1 "test_group"
|
obsws-cli projector open --monitor-index=1 "test_group"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Screenshot
|
||||||
|
|
||||||
|
- save: Take a screenshot and save it to a file.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --width:
|
||||||
|
- defaults to 1920
|
||||||
|
- --height:
|
||||||
|
- defaults to 1080
|
||||||
|
- --quality:
|
||||||
|
- defaults to -1
|
||||||
|
|
||||||
|
- args: <source_name> <output_path>
|
||||||
|
|
||||||
|
```console
|
||||||
|
obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -587,4 +682,5 @@ obsws-cli projector open --monitor-index=1 "test_group"
|
|||||||
|
|
||||||
|
|
||||||
[obs-studio]: https://obsproject.com/
|
[obs-studio]: https://obsproject.com/
|
||||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
||||||
|
[no-colour]: https://no-color.org/
|
||||||
|
|||||||
BIN
img/coloured-border.png
Executable file
BIN
img/coloured-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
BIN
img/coloured-no-border.png
Executable file
BIN
img/coloured-no-border.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
BIN
img/colourless.png
Executable file
BIN
img/colourless.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
@@ -1,4 +1,4 @@
|
|||||||
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
|
||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
__version__ = "0.15.0"
|
__version__ = '0.20.2'
|
||||||
|
|||||||
@@ -2,6 +2,6 @@
|
|||||||
#
|
#
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
from .app import app
|
from .app import run
|
||||||
|
|
||||||
__all__ = ["app"]
|
__all__ = ['run']
|
||||||
|
|||||||
@@ -1,28 +0,0 @@
|
|||||||
"""module defining a custom group class for handling command name aliases."""
|
|
||||||
|
|
||||||
import re
|
|
||||||
|
|
||||||
import typer
|
|
||||||
|
|
||||||
|
|
||||||
class AliasGroup(typer.core.TyperGroup):
|
|
||||||
"""A custom group class to handle command name aliases."""
|
|
||||||
|
|
||||||
_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():
|
|
||||||
name = cmd.name
|
|
||||||
if name and default_name in self._CMD_SPLIT_P.split(name):
|
|
||||||
return name
|
|
||||||
return default_name
|
|
||||||
201
obsws_cli/app.py
201
obsws_cli/app.py
@@ -1,102 +1,137 @@
|
|||||||
"""Command line interface for the OBS WebSocket API."""
|
"""Command line interface for the OBS WebSocket API."""
|
||||||
|
|
||||||
from typing import Annotated
|
import importlib
|
||||||
|
import logging
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Annotated, Any
|
||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
from cyclopts import App, Group, Parameter, config
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from obsws_cli.__about__ import __version__ as obsws_cli_version
|
from obsws_cli.__about__ import __version__ as version
|
||||||
|
|
||||||
from . import (
|
from . import console, styles
|
||||||
filter,
|
from .context import Context
|
||||||
group,
|
from .error import OBSWSCLIError
|
||||||
hotkey,
|
|
||||||
input,
|
app = App(
|
||||||
profile,
|
config=config.Env(
|
||||||
projector,
|
'OBS_'
|
||||||
record,
|
), # Environment variable prefix for configuration parameters
|
||||||
replaybuffer,
|
version=version,
|
||||||
scene,
|
usage='[bold][yellow]Usage:[/yellow] [white]obsws-cli [OPTIONS] COMMAND [ARGS]...[/white][/bold]',
|
||||||
scenecollection,
|
|
||||||
sceneitem,
|
|
||||||
settings,
|
|
||||||
stream,
|
|
||||||
studiomode,
|
|
||||||
virtualcam,
|
|
||||||
)
|
)
|
||||||
from .alias import AliasGroup
|
app.meta.group_parameters = Group('Options', sort_key=0)
|
||||||
|
for sub_app in (
|
||||||
app = typer.Typer(cls=AliasGroup)
|
'filter',
|
||||||
for module in (
|
'group',
|
||||||
filter,
|
'hotkey',
|
||||||
group,
|
'input',
|
||||||
hotkey,
|
'profile',
|
||||||
input,
|
'projector',
|
||||||
projector,
|
'record',
|
||||||
profile,
|
'replaybuffer',
|
||||||
record,
|
'scene',
|
||||||
replaybuffer,
|
'scenecollection',
|
||||||
scene,
|
'sceneitem',
|
||||||
scenecollection,
|
'screenshot',
|
||||||
sceneitem,
|
'stream',
|
||||||
stream,
|
'studiomode',
|
||||||
studiomode,
|
'text',
|
||||||
virtualcam,
|
'virtualcam',
|
||||||
):
|
):
|
||||||
app.add_typer(module.app, name=module.__name__.split('.')[-1])
|
module = importlib.import_module(f'.{sub_app}', package=__package__)
|
||||||
|
app.command(module.app)
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
def version_callback(value: bool):
|
@Parameter(name='*')
|
||||||
"""Show the version of the CLI."""
|
@dataclass
|
||||||
if value:
|
class OBSConfig:
|
||||||
typer.echo(f'obsws_cli version: {obsws_cli_version}')
|
"""Dataclass to hold OBS connection parameters.
|
||||||
raise typer.Exit()
|
|
||||||
|
Attributes:
|
||||||
|
host (str): The hostname or IP address of the OBS WebSocket server.
|
||||||
|
port (int): The port number of the OBS WebSocket server.
|
||||||
|
password (str): The password for the OBS WebSocket server, if required.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
host: str = 'localhost'
|
||||||
|
port: int = 4455
|
||||||
|
password: str = ''
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@dataclass
|
||||||
def main(
|
class StyleConfig:
|
||||||
ctx: typer.Context,
|
"""Dataclass to hold style parameters.
|
||||||
host: Annotated[
|
|
||||||
str,
|
Attributes:
|
||||||
typer.Option(
|
name (str): The name of the style to use for console output.
|
||||||
envvar='OBS_HOST', help='WebSocket host', show_default='localhost'
|
no_border (bool): Whether to style the borders in the console output.
|
||||||
),
|
|
||||||
] = settings.get('HOST'),
|
"""
|
||||||
port: Annotated[
|
|
||||||
int, typer.Option(envvar='OBS_PORT', help='WebSocket port', show_default=4455)
|
name: str = 'disabled'
|
||||||
] = settings.get('PORT'),
|
no_border: bool = False
|
||||||
password: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Option(envvar='OBS_PASSWORD', help='WebSocket password', show_default=''),
|
def setup_logging(type_, value: Any):
|
||||||
] = settings.get('PASSWORD'),
|
"""Set up logging for the application."""
|
||||||
timeout: Annotated[
|
log_level = logging.DEBUG if value else logging.CRITICAL
|
||||||
int,
|
logging.basicConfig(
|
||||||
typer.Option(envvar='OBS_TIMEOUT', help='WebSocket timeout', show_default=5),
|
level=log_level,
|
||||||
] = settings.get('TIMEOUT'),
|
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
|
||||||
version: Annotated[
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.meta.default
|
||||||
|
def launcher(
|
||||||
|
*tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
|
||||||
|
obs_config: OBSConfig,
|
||||||
|
style_config: StyleConfig,
|
||||||
|
debug: Annotated[
|
||||||
bool,
|
bool,
|
||||||
typer.Option(
|
Parameter(validator=setup_logging, help='Enable debug logging'),
|
||||||
'--version',
|
|
||||||
'-v',
|
|
||||||
is_eager=True,
|
|
||||||
help='Show the CLI version and exit',
|
|
||||||
show_default=False,
|
|
||||||
callback=version_callback,
|
|
||||||
),
|
|
||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""obsws_cli is a command line interface for the OBS WebSocket API."""
|
"""Command line interface for the OBS WebSocket API."""
|
||||||
ctx.obj = ctx.with_resource(obsws.ReqClient(**ctx.params))
|
with obsws.ReqClient(
|
||||||
|
host=obs_config.host,
|
||||||
|
port=obs_config.port,
|
||||||
|
password=obs_config.password,
|
||||||
|
) as client:
|
||||||
|
additional_kwargs = {}
|
||||||
|
command, bound, ignored = app.parse_args(tokens)
|
||||||
|
if 'ctx' in ignored:
|
||||||
|
# If 'ctx' is in ignored, it means it was not passed as an argument
|
||||||
|
# and we need to add it to the bound arguments.
|
||||||
|
additional_kwargs['ctx'] = ignored['ctx'](
|
||||||
|
client,
|
||||||
|
styles.request_style_obj(style_config.name, style_config.no_border),
|
||||||
|
)
|
||||||
|
return command(*bound.args, **bound.kwargs, **additional_kwargs)
|
||||||
|
|
||||||
|
|
||||||
@app.command()
|
@app.command
|
||||||
def obs_version(ctx: typer.Context):
|
def obs_version(
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
"""Get the OBS Client and WebSocket versions."""
|
"""Get the OBS Client and WebSocket versions."""
|
||||||
resp = ctx.obj.get_version()
|
resp = ctx.client.get_version()
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'OBS Client version: {resp.obs_version} with WebSocket version: {resp.obs_web_socket_version}'
|
f'OBS Client version: {console.highlight(ctx, resp.obs_version)}'
|
||||||
|
f' with WebSocket version: {console.highlight(ctx, resp.obs_web_socket_version)}'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run():
|
||||||
|
"""Run the OBS WebSocket CLI application.
|
||||||
|
|
||||||
|
Handles exceptions and prints error messages to the console.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
app.meta()
|
||||||
|
except OBSWSCLIError as e:
|
||||||
|
console.err.print(f'Error: {e}')
|
||||||
|
return e.code
|
||||||
|
|||||||
13
obsws_cli/console.py
Normal file
13
obsws_cli/console.py
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
"""module for console output handling in obsws_cli."""
|
||||||
|
|
||||||
|
from rich.console import Console
|
||||||
|
|
||||||
|
from .context import Context
|
||||||
|
|
||||||
|
out = Console()
|
||||||
|
err = Console(stderr=True, style='bold red')
|
||||||
|
|
||||||
|
|
||||||
|
def highlight(ctx: Context, text: str) -> str:
|
||||||
|
"""Highlight text using the current context's style."""
|
||||||
|
return f'[{ctx.style.highlight}]{text}[/{ctx.style.highlight}]'
|
||||||
15
obsws_cli/context.py
Normal file
15
obsws_cli/context.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
"""module for managing the application context."""
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
import obsws_python as obsws
|
||||||
|
|
||||||
|
from . import styles
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Context:
|
||||||
|
"""Context for the application, holding OBS and style configurations."""
|
||||||
|
|
||||||
|
client: obsws.ReqClient
|
||||||
|
style: styles.Style
|
||||||
10
obsws_cli/enum.py
Normal file
10
obsws_cli/enum.py
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
"""module for exit codes used in the application."""
|
||||||
|
|
||||||
|
from enum import IntEnum, auto
|
||||||
|
|
||||||
|
|
||||||
|
class ExitCode(IntEnum):
|
||||||
|
"""Exit codes for the application."""
|
||||||
|
|
||||||
|
SUCCESS = 0
|
||||||
|
ERROR = auto()
|
||||||
11
obsws_cli/error.py
Normal file
11
obsws_cli/error.py
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
"""module containing error handling for OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
|
||||||
|
class OBSWSCLIError(Exception):
|
||||||
|
"""Base class for OBS WebSocket CLI errors."""
|
||||||
|
|
||||||
|
def __init__(self, message: str, code: int = 1):
|
||||||
|
"""Initialize the error with a message and an optional code."""
|
||||||
|
super().__init__(message)
|
||||||
|
self.message = message
|
||||||
|
self.code = code
|
||||||
@@ -1,134 +1,221 @@
|
|||||||
"""module containing commands for manipulating filters in scenes."""
|
"""module containing commands for manipulating filters in scenes."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
import obsws_python as obsws
|
import obsws_python as obsws
|
||||||
import typer
|
from cyclopts import App, Parameter
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from . import util
|
from . import console, util
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='filter', help='Commands for managing filters in OBS sources')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control filters in OBS scenes."""
|
source_name: Optional[str] = None,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""List filters for a source.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str, optional
|
||||||
|
The name of the source to list filters for. If not provided, the current program scene's source will be used.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not source_name:
|
||||||
|
source_name = ctx.client.get_current_program_scene().scene_name
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list(ctx: typer.Context, source_name: str):
|
|
||||||
"""List filters for a source."""
|
|
||||||
try:
|
try:
|
||||||
resp = ctx.obj.get_source_filter_list(source_name)
|
resp = ctx.client.get_source_filter_list(source_name)
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
if e.code == 600:
|
if e.code == 600:
|
||||||
err_console.print(f"No source was found by the name of '{source_name}'.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'No source found by the name of [yellow]{source_name}[/yellow].',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
if not resp.filters:
|
if not resp.filters:
|
||||||
out_console.print(f'No filters found for source {source_name}')
|
console.out.print(
|
||||||
raise typer.Exit()
|
f'No filters found for source {console.highlight(ctx, source_name)}'
|
||||||
|
|
||||||
table = Table(title=f'Filters for Source: {source_name}', padding=(0, 2))
|
|
||||||
|
|
||||||
for column in ('Filter Name', 'Kind', 'Enabled', 'Settings'):
|
|
||||||
table.add_column(
|
|
||||||
column,
|
|
||||||
justify='left' if column in ('Filter Name', 'Kind') else 'center',
|
|
||||||
style='cyan',
|
|
||||||
)
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title=f'Filters for Source: {source_name}',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
|
||||||
|
columns = [
|
||||||
|
(Text('Filter Name', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Kind', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Enabled', justify='center'), 'center', None),
|
||||||
|
(Text('Settings', justify='center'), 'center', ctx.style.column),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for filter in resp.filters:
|
for filter in resp.filters:
|
||||||
|
resp = ctx.client.get_source_filter_default_settings(filter['filterKind'])
|
||||||
|
settings = resp.default_filter_settings | filter['filterSettings']
|
||||||
|
|
||||||
table.add_row(
|
table.add_row(
|
||||||
filter['filterName'],
|
filter['filterName'],
|
||||||
util.snakecase_to_titlecase(filter['filterKind']),
|
util.snakecase_to_titlecase(filter['filterKind']),
|
||||||
':white_heavy_check_mark:' if filter['filterEnabled'] else ':x:',
|
util.check_mark(filter['filterEnabled']),
|
||||||
'\n'.join(
|
'\n'.join(
|
||||||
[
|
[
|
||||||
f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
|
f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
|
||||||
for k, v in filter['filterSettings'].items()
|
for k, v in settings.items()
|
||||||
]
|
]
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
|
def _get_filter_enabled(ctx: Context, source_name: str, filter_name: str):
|
||||||
"""Get the status of a filter for a source."""
|
"""Get the status of a filter for a source."""
|
||||||
resp = ctx.obj.get_source_filter(source_name, filter_name)
|
resp = ctx.client.get_source_filter(source_name, filter_name)
|
||||||
return resp.filter_enabled
|
return resp.filter_enabled
|
||||||
|
|
||||||
|
|
||||||
@app.command('enable | on')
|
@app.command(name=['enable', 'on'])
|
||||||
def enable(
|
def enable(
|
||||||
ctx: typer.Context,
|
source_name: str,
|
||||||
source_name: str = typer.Argument(..., help='The source to enable the filter for'),
|
filter_name: str,
|
||||||
filter_name: str = typer.Argument(..., help='The name of the filter to enable'),
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Enable a filter for a source."""
|
"""Enable a filter for a source.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str
|
||||||
|
The name of the source to enable the filter for.
|
||||||
|
filter_name : str
|
||||||
|
The name of the filter to enable.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if _get_filter_enabled(ctx, source_name, filter_name):
|
if _get_filter_enabled(ctx, source_name, filter_name):
|
||||||
err_console.print(
|
raise OBSWSCLIError(
|
||||||
f'Filter {filter_name} is already enabled for source {source_name}'
|
f'Filter [yellow]{filter_name}[/yellow] is already enabled for source [yellow]{source_name}[/yellow]',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=True)
|
ctx.client.set_source_filter_enabled(source_name, filter_name, enabled=True)
|
||||||
out_console.print(f'Enabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('disable | off')
|
@app.command(name=['disable', 'off'])
|
||||||
def disable(
|
def disable(
|
||||||
ctx: typer.Context,
|
source_name: str,
|
||||||
source_name: str = typer.Argument(..., help='The source to disable the filter for'),
|
filter_name: str,
|
||||||
filter_name: str = typer.Argument(..., help='The name of the filter to disable'),
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Disable a filter for a source."""
|
"""Disable a filter for a source.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str
|
||||||
|
The name of the source to disable the filter for.
|
||||||
|
filter_name : str
|
||||||
|
The name of the filter to disable.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not _get_filter_enabled(ctx, source_name, filter_name):
|
if not _get_filter_enabled(ctx, source_name, filter_name):
|
||||||
err_console.print(
|
raise OBSWSCLIError(
|
||||||
f'Filter {filter_name} is already disabled for source {source_name}'
|
f'Filter [yellow]{filter_name}[/yellow] is already disabled for source [yellow]{source_name}[/yellow]',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=False)
|
ctx.client.set_source_filter_enabled(source_name, filter_name, enabled=False)
|
||||||
out_console.print(f'Disabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(
|
def toggle(
|
||||||
ctx: typer.Context,
|
source_name: str,
|
||||||
source_name: str = typer.Argument(..., help='The source to toggle the filter for'),
|
filter_name: str,
|
||||||
filter_name: str = typer.Argument(..., help='The name of the filter to toggle'),
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Toggle a filter for a source."""
|
"""Toggle a filter for a source.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str
|
||||||
|
The name of the source to toggle the filter for.
|
||||||
|
filter_name : str
|
||||||
|
The name of the filter to toggle.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
||||||
new_state = not is_enabled
|
new_state = not is_enabled
|
||||||
|
|
||||||
ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
|
ctx.client.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
|
||||||
if new_state:
|
if new_state:
|
||||||
out_console.print(f'Enabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(f'Disabled filter {filter_name} for source {source_name}')
|
console.out.print(
|
||||||
|
f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(
|
def status(
|
||||||
ctx: typer.Context,
|
source_name: str,
|
||||||
source_name: str = typer.Argument(
|
filter_name: str,
|
||||||
..., help='The source to get the filter status for'
|
/,
|
||||||
),
|
*,
|
||||||
filter_name: str = typer.Argument(
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
..., help='The name of the filter to get the status for'
|
|
||||||
),
|
|
||||||
):
|
):
|
||||||
"""Get the status of a filter for a source."""
|
"""Get the status of a filter for a source.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str
|
||||||
|
The name of the source to check the filter status for.
|
||||||
|
filter_name : str
|
||||||
|
The name of the filter to check the status for.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
|
||||||
if is_enabled:
|
if is_enabled:
|
||||||
out_console.print(f'Filter {filter_name} is enabled for source {source_name}')
|
console.out.print(
|
||||||
|
f'Filter {console.highlight(ctx, filter_name)} is enabled for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(f'Filter {filter_name} is disabled for source {source_name}')
|
console.out.print(
|
||||||
|
f'Filter {console.highlight(ctx, filter_name)} is disabled for source {console.highlight(ctx, source_name)}'
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,39 +1,48 @@
|
|||||||
"""module containing commands for manipulating groups in scenes."""
|
"""module containing commands for manipulating groups in scenes."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated, Optional
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
|
||||||
|
|
||||||
from . import validate
|
from cyclopts import App, Parameter
|
||||||
from .alias import AliasGroup
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
|
from . import console, util, validate
|
||||||
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
from .protocols import DataclassProtocol
|
from .protocols import DataclassProtocol
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='group', help='Commands for managing groups in OBS scenes')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control groups in OBS scenes."""
|
scene_name: Optional[str] = None,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
@app.command('list | ls')
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
def list(
|
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str = typer.Argument(
|
|
||||||
None, help='Scene name (optional, defaults to current scene)'
|
|
||||||
),
|
|
||||||
):
|
):
|
||||||
"""List groups in a scene."""
|
"""List groups in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str, optional
|
||||||
|
The name of the scene to list groups for. If not provided, the current program scene
|
||||||
|
will be used.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not scene_name:
|
if not scene_name:
|
||||||
scene_name = ctx.obj.get_current_program_scene().scene_name
|
scene_name = ctx.client.get_current_program_scene().scene_name
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
groups = [
|
groups = [
|
||||||
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
|
||||||
for item in resp.scene_items
|
for item in resp.scene_items
|
||||||
@@ -41,24 +50,33 @@ def list(
|
|||||||
]
|
]
|
||||||
|
|
||||||
if not groups:
|
if not groups:
|
||||||
out_console.print(f"No groups found in scene '{scene_name}'.")
|
console.out.print(
|
||||||
raise typer.Exit()
|
f'No groups found in scene {console.highlight(ctx, scene_name)}.'
|
||||||
|
|
||||||
table = Table(title=f'Groups in Scene: {scene_name}', padding=(0, 2))
|
|
||||||
|
|
||||||
for column in ('ID', 'Group Name', 'Enabled'):
|
|
||||||
table.add_column(
|
|
||||||
column, justify='left' if column == 'Group Name' else 'center', style='cyan'
|
|
||||||
)
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title=f'Groups in Scene: {scene_name}',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
|
||||||
|
columns = [
|
||||||
|
(Text('ID', justify='center'), 'center', ctx.style.column),
|
||||||
|
(Text('Group Name', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Enabled', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for item_id, group_name, is_enabled in groups:
|
for item_id, group_name, is_enabled in groups:
|
||||||
table.add_row(
|
table.add_row(
|
||||||
str(item_id),
|
str(item_id),
|
||||||
group_name,
|
group_name,
|
||||||
':white_heavy_check_mark:' if is_enabled else ':x:',
|
util.check_mark(is_enabled),
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
||||||
@@ -74,91 +92,175 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
|
|||||||
return group
|
return group
|
||||||
|
|
||||||
|
|
||||||
@app.command('show | sh')
|
@app.command(name=['show', 'sh'])
|
||||||
def show(ctx: typer.Context, scene_name: str, group_name: str):
|
def show(
|
||||||
"""Show a group in a scene."""
|
scene_name: str,
|
||||||
|
group_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Show a group in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene where the group is located.
|
||||||
|
group_name : str
|
||||||
|
The name of the group to show.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(group.get('sceneItemId')),
|
item_id=int(group.get('sceneItemId')),
|
||||||
enabled=True,
|
enabled=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('hide | h')
|
@app.command(name=['hide', 'h'])
|
||||||
def hide(ctx: typer.Context, scene_name: str, group_name: str):
|
def hide(
|
||||||
"""Hide a group in a scene."""
|
scene_name: str,
|
||||||
|
group_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Hide a group in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene where the group is located.
|
||||||
|
group_name : str
|
||||||
|
The name of the group to hide.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(group.get('sceneItemId')),
|
item_id=int(group.get('sceneItemId')),
|
||||||
enabled=False,
|
enabled=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(ctx: typer.Context, scene_name: str, group_name: str):
|
def toggle(
|
||||||
"""Toggle a group in a scene."""
|
scene_name: str,
|
||||||
|
group_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Toggle a group in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene where the group is located.
|
||||||
|
group_name : str
|
||||||
|
The name of the group to toggle.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
new_state = not group.get('sceneItemEnabled')
|
new_state = not group.get('sceneItemEnabled')
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(group.get('sceneItemId')),
|
item_id=int(group.get('sceneItemId')),
|
||||||
enabled=new_state,
|
enabled=new_state,
|
||||||
)
|
)
|
||||||
|
|
||||||
if new_state:
|
if new_state:
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
else:
|
else:
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context, scene_name: str, group_name: str):
|
def status(
|
||||||
"""Get the status of a group in a scene."""
|
scene_name: str,
|
||||||
|
group_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the status of a group in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene where the group is located.
|
||||||
|
group_name : str
|
||||||
|
The name of the group to check.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
if (group := _get_group(group_name, resp)) is None:
|
if (group := _get_group(group_name, resp)) is None:
|
||||||
err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
enabled = ctx.client.get_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(group.get('sceneItemId')),
|
item_id=int(group.get('sceneItemId')),
|
||||||
)
|
)
|
||||||
|
|
||||||
if enabled.scene_item_enabled:
|
if enabled.scene_item_enabled:
|
||||||
out_console.print(f"Group '{group_name}' is now visible.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
|
||||||
else:
|
else:
|
||||||
out_console.print(f"Group '{group_name}' is now hidden.")
|
console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
|
||||||
|
|||||||
@@ -1,57 +1,96 @@
|
|||||||
"""module containing commands for hotkey management."""
|
"""module containing commands for hotkey management."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
from cyclopts import App, Parameter
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from . import console
|
||||||
|
from .context import Context
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='hotkey', help='Commands for managing hotkeys in OBS')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control hotkeys in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
|
||||||
@app.command('list | ls')
|
|
||||||
def list(
|
|
||||||
ctx: typer.Context,
|
|
||||||
):
|
):
|
||||||
"""List all hotkeys."""
|
"""List all hotkeys.
|
||||||
resp = ctx.obj.get_hotkey_list()
|
|
||||||
|
|
||||||
table = Table(title='Hotkeys', padding=(0, 2))
|
Parameters
|
||||||
table.add_column('Hotkey Name', justify='left', style='cyan')
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client to interact with.
|
||||||
|
|
||||||
for hotkey in resp.hotkeys:
|
"""
|
||||||
table.add_row(hotkey)
|
resp = ctx.client.get_hotkey_list()
|
||||||
|
|
||||||
out_console.print(table)
|
table = Table(
|
||||||
|
title='Hotkeys',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Hotkey Name', justify='center'),
|
||||||
|
justify='left',
|
||||||
|
style=ctx.style.column,
|
||||||
|
)
|
||||||
|
|
||||||
|
for i, hotkey in enumerate(resp.hotkeys):
|
||||||
|
table.add_row(hotkey, style='' if i % 2 == 0 else 'dim')
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('trigger | tr')
|
@app.command(name=['trigger', 'tr'])
|
||||||
def trigger(
|
def trigger(
|
||||||
ctx: typer.Context,
|
hotkey: str,
|
||||||
hotkey: str = typer.Argument(..., help='The hotkey to trigger'),
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Trigger a hotkey by name."""
|
"""Trigger a hotkey by name.
|
||||||
ctx.obj.trigger_hotkey_by_name(hotkey)
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
hotkey : str
|
||||||
|
The name of the hotkey to trigger.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client to interact with.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.trigger_hotkey_by_name(hotkey)
|
||||||
|
|
||||||
|
|
||||||
@app.command('trigger-sequence | trs')
|
@app.command(name=['trigger-sequence', 'trs'])
|
||||||
def trigger_sequence(
|
def trigger_sequence(
|
||||||
ctx: typer.Context,
|
key_id: str,
|
||||||
shift: bool = typer.Option(False, help='Press shift when triggering the hotkey'),
|
/,
|
||||||
ctrl: bool = typer.Option(False, help='Press control when triggering the hotkey'),
|
shift: bool = False,
|
||||||
alt: bool = typer.Option(False, help='Press alt when triggering the hotkey'),
|
ctrl: bool = False,
|
||||||
cmd: bool = typer.Option(False, help='Press cmd when triggering the hotkey'),
|
alt: bool = False,
|
||||||
key_id: str = typer.Argument(
|
cmd: bool = False,
|
||||||
...,
|
*,
|
||||||
help='The OBS key ID to trigger, see https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#hotkey for more info',
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
),
|
|
||||||
):
|
):
|
||||||
"""Trigger a hotkey by sequence."""
|
"""Trigger a hotkey by sequence.
|
||||||
ctx.obj.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
key_id : str
|
||||||
|
The OBS key ID to trigger, see https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#hotkey for more info
|
||||||
|
shift : bool, optional
|
||||||
|
Press shift when triggering the hotkey (default is False)
|
||||||
|
ctrl : bool, optional
|
||||||
|
Press control when triggering the hotkey (default is False)
|
||||||
|
alt : bool, optional
|
||||||
|
Press alt when triggering the hotkey (default is False)
|
||||||
|
cmd : bool, optional
|
||||||
|
Press cmd when triggering the hotkey (default is False)
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client to interact with.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
|
||||||
|
|||||||
@@ -2,32 +2,51 @@
|
|||||||
|
|
||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import typer
|
import obsws_python as obsws
|
||||||
from rich.console import Console
|
from cyclopts import App, Parameter
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from . import util, validate
|
from . import console, util, validate
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='input', help='Commands for managing inputs in OBS')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control inputs in OBS."""
|
input: bool = False,
|
||||||
|
output: bool = False,
|
||||||
|
colour: bool = False,
|
||||||
@app.command('list | ls')
|
ffmpeg: bool = False,
|
||||||
def list(
|
vlc: bool = False,
|
||||||
ctx: typer.Context,
|
uuid: bool = False,
|
||||||
input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
|
*,
|
||||||
output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
|
|
||||||
):
|
):
|
||||||
"""List all inputs."""
|
"""List all inputs.
|
||||||
resp = ctx.obj.get_input_list()
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input:
|
||||||
|
Filter by input type.
|
||||||
|
output:
|
||||||
|
Filter by output type.
|
||||||
|
colour:
|
||||||
|
Filter by colour source type.
|
||||||
|
ffmpeg:
|
||||||
|
Filter by ffmpeg source type.
|
||||||
|
vlc:
|
||||||
|
Filter by VLC source type.
|
||||||
|
uuid:
|
||||||
|
Show UUIDs of inputs.
|
||||||
|
ctx:
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_input_list()
|
||||||
|
|
||||||
kinds = []
|
kinds = []
|
||||||
if input:
|
if input:
|
||||||
@@ -36,81 +55,171 @@ def list(
|
|||||||
kinds.append('output')
|
kinds.append('output')
|
||||||
if colour:
|
if colour:
|
||||||
kinds.append('color')
|
kinds.append('color')
|
||||||
if not any([input, output, colour]):
|
if ffmpeg:
|
||||||
kinds = ['input', 'output', 'color']
|
kinds.append('ffmpeg')
|
||||||
|
if vlc:
|
||||||
|
kinds.append('vlc')
|
||||||
|
if not any([input, output, colour, ffmpeg, vlc]):
|
||||||
|
kinds = ctx.client.get_input_kind_list(False).input_kinds
|
||||||
|
|
||||||
inputs = [
|
inputs = sorted(
|
||||||
(input_.get('inputName'), input_.get('inputKind'))
|
(
|
||||||
for input_ in filter(
|
(input_.get('inputName'), input_.get('inputKind'), input_.get('inputUuid'))
|
||||||
lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
|
for input_ in filter(
|
||||||
resp.inputs,
|
lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
|
||||||
)
|
resp.inputs,
|
||||||
]
|
)
|
||||||
|
),
|
||||||
|
key=lambda x: x[0], # Sort by input name
|
||||||
|
)
|
||||||
|
|
||||||
if not inputs:
|
if not inputs:
|
||||||
out_console.print('No inputs found.')
|
console.out.print('No inputs found matching the specified filters.')
|
||||||
raise typer.Exit()
|
return
|
||||||
|
|
||||||
table = Table(title='Inputs', padding=(0, 2))
|
table = Table(title='Inputs', padding=(0, 2), border_style=ctx.style.border)
|
||||||
for column in ('Input Name', 'Kind'):
|
if uuid:
|
||||||
table.add_column(
|
columns = [
|
||||||
column, justify='left' if column == 'Input Name' else 'center', style='cyan'
|
(Text('Input Name', justify='center'), 'left', ctx.style.column),
|
||||||
)
|
(Text('Kind', justify='center'), 'center', ctx.style.column),
|
||||||
|
(Text('Muted', justify='center'), 'center', None),
|
||||||
|
(Text('UUID', justify='center'), 'left', ctx.style.column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
(Text('Input Name', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Kind', justify='center'), 'center', ctx.style.column),
|
||||||
|
(Text('Muted', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for input_name, input_kind in inputs:
|
for input_name, input_kind, input_uuid in inputs:
|
||||||
table.add_row(
|
input_mark = ''
|
||||||
input_name,
|
try:
|
||||||
util.snakecase_to_titlecase(input_kind),
|
input_muted = ctx.client.get_input_mute(name=input_name).input_muted
|
||||||
)
|
input_mark = util.check_mark(input_muted)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
if e.code == 604: # Input does not support audio
|
||||||
|
input_mark = 'N/A'
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
out_console.print(table)
|
if uuid:
|
||||||
|
table.add_row(
|
||||||
|
input_name,
|
||||||
|
util.snakecase_to_titlecase(input_kind),
|
||||||
|
input_mark,
|
||||||
|
input_uuid,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
input_name,
|
||||||
|
util.snakecase_to_titlecase(input_kind),
|
||||||
|
input_mark,
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('mute | m')
|
@app.command(name=['mute', 'm'])
|
||||||
def mute(ctx: typer.Context, input_name: str):
|
def mute(
|
||||||
"""Mute an input."""
|
input_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Mute an input.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input_name: str
|
||||||
|
Name of the input to mute.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
if not validate.input_in_inputs(ctx, input_name):
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Input [yellow]{input_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
ctx.client.set_input_mute(
|
||||||
name=input_name,
|
name=input_name,
|
||||||
muted=True,
|
muted=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(f"Input '{input_name}' muted.")
|
console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('unmute | um')
|
@app.command(name=['unmute', 'um'])
|
||||||
def unmute(ctx: typer.Context, input_name: str):
|
def unmute(
|
||||||
"""Unmute an input."""
|
input_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Unmute an input.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input_name: str
|
||||||
|
Name of the input to unmute.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
if not validate.input_in_inputs(ctx, input_name):
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Input [yellow]{input_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
ctx.client.set_input_mute(
|
||||||
name=input_name,
|
name=input_name,
|
||||||
muted=False,
|
muted=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(f"Input '{input_name}' unmuted.")
|
console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(ctx: typer.Context, input_name: str):
|
def toggle(
|
||||||
"""Toggle an input."""
|
input_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Toggle an input.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input_name: str
|
||||||
|
Name of the input to toggle.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.input_in_inputs(ctx, input_name):
|
if not validate.input_in_inputs(ctx, input_name):
|
||||||
err_console.print(f"Input '{input_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Input [yellow]{input_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_input_mute(name=input_name)
|
resp = ctx.client.get_input_mute(name=input_name)
|
||||||
new_state = not resp.input_muted
|
new_state = not resp.input_muted
|
||||||
|
|
||||||
ctx.obj.set_input_mute(
|
ctx.client.set_input_mute(
|
||||||
name=input_name,
|
name=input_name,
|
||||||
muted=new_state,
|
muted=new_state,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(
|
if new_state:
|
||||||
f"Input '{input_name}' {'muted' if new_state else 'unmuted'}.",
|
console.out.print(
|
||||||
)
|
f'Input {console.highlight(ctx, input_name)} muted.',
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
console.out.print(
|
||||||
|
f'Input {console.highlight(ctx, input_name)} unmuted.',
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,84 +1,161 @@
|
|||||||
"""module containing commands for manipulating profiles in OBS."""
|
"""module containing commands for manipulating profiles in OBS."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
from cyclopts import App, Parameter
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from . import validate
|
from . import console, util, validate
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='profile', help='Commands for managing profiles in OBS')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control profiles in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""List profiles.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
@app.command('list | ls')
|
"""
|
||||||
def list(ctx: typer.Context):
|
resp = ctx.client.get_profile_list()
|
||||||
"""List profiles."""
|
|
||||||
resp = ctx.obj.get_profile_list()
|
|
||||||
|
|
||||||
table = Table(title='Profiles', padding=(0, 2))
|
table = Table(title='Profiles', padding=(0, 2), border_style=ctx.style.border)
|
||||||
for column in ('Profile Name', 'Current'):
|
columns = [
|
||||||
table.add_column(
|
(Text('Profile Name', justify='center'), 'left', ctx.style.column),
|
||||||
column,
|
(Text('Current', justify='center'), 'center', None),
|
||||||
justify='left' if column == 'Profile Name' else 'center',
|
]
|
||||||
style='cyan',
|
for heading, justify, style in columns:
|
||||||
)
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
if not resp.profiles:
|
||||||
|
console.out.print('No profiles found.')
|
||||||
|
return
|
||||||
|
|
||||||
for profile in resp.profiles:
|
for profile in resp.profiles:
|
||||||
table.add_row(
|
table.add_row(
|
||||||
profile,
|
profile,
|
||||||
':white_heavy_check_mark:' if profile == resp.current_profile_name else '',
|
util.check_mark(
|
||||||
|
ctx, profile == resp.current_profile_name, empty_if_false=True
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command(name=['current', 'get'])
|
||||||
def current(ctx: typer.Context):
|
def current(
|
||||||
"""Get the current profile."""
|
*,
|
||||||
resp = ctx.obj.get_profile_list()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print(resp.current_profile_name)
|
):
|
||||||
|
"""Get the current profile.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_profile_list()
|
||||||
|
console.out.print(
|
||||||
|
f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command(name=['switch', 'set'])
|
||||||
def switch(ctx: typer.Context, profile_name: str):
|
def switch(
|
||||||
"""Switch to a profile."""
|
profile_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Switch to a profile.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
profile_name: str
|
||||||
|
Name of the profile to switch to.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
if not validate.profile_exists(ctx, profile_name):
|
||||||
err_console.print(f"Profile '{profile_name}' not found.")
|
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
|
||||||
raise typer.Exit(1)
|
raise OBSWSCLIError(
|
||||||
|
f'Profile [yellow]{profile_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_profile_list()
|
resp = ctx.client.get_profile_list()
|
||||||
if resp.current_profile_name == profile_name:
|
if resp.current_profile_name == profile_name:
|
||||||
err_console.print(f"Profile '{profile_name}' is already the current profile.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Profile [yellow]{profile_name}[/yellow] is already the current profile.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.set_current_profile(profile_name)
|
ctx.client.set_current_profile(profile_name)
|
||||||
out_console.print(f"Switched to profile '{profile_name}'.")
|
console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
@app.command(name=['create', 'new'])
|
||||||
def create(ctx: typer.Context, profile_name: str):
|
def create(
|
||||||
"""Create a new profile."""
|
profile_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Create a new profile.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
profile_name: str
|
||||||
|
Name of the profile to create.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if validate.profile_exists(ctx, profile_name):
|
if validate.profile_exists(ctx, profile_name):
|
||||||
err_console.print(f"Profile '{profile_name}' already exists.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Profile [yellow]{profile_name}[/yellow] already exists.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.create_profile(profile_name)
|
ctx.client.create_profile(profile_name)
|
||||||
out_console.print(f"Created profile '{profile_name}'.")
|
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('remove | rm')
|
@app.command(name=['remove', 'rm'])
|
||||||
def remove(ctx: typer.Context, profile_name: str):
|
def remove(
|
||||||
"""Remove a profile."""
|
profile_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Remove a profile.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
profile_name: str
|
||||||
|
Name of the profile to remove.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the client and style.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.profile_exists(ctx, profile_name):
|
if not validate.profile_exists(ctx, profile_name):
|
||||||
err_console.print(f"Profile '{profile_name}' not found.")
|
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
|
||||||
raise typer.Exit(1)
|
raise OBSWSCLIError(
|
||||||
|
f'Profile [yellow]{profile_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.remove_profile(profile_name)
|
ctx.client.remove_profile(profile_name)
|
||||||
out_console.print(f"Removed profile '{profile_name}'.")
|
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')
|
||||||
|
|||||||
@@ -1,30 +1,36 @@
|
|||||||
"""module containing commands for manipulating projectors in OBS."""
|
"""module containing commands for manipulating projectors in OBS."""
|
||||||
|
|
||||||
from typing import Annotated
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
import typer
|
from cyclopts import App, Parameter, validators
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from . import console
|
||||||
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='projector', help='Commands for managing projectors in OBS')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list-monitors', 'ls-m'])
|
||||||
def main():
|
def list_monitors(
|
||||||
"""Control projectors in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""List available monitors.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
@app.command('list-monitors | ls-m')
|
"""
|
||||||
def list_monitors(ctx: typer.Context):
|
resp = ctx.client.get_monitor_list()
|
||||||
"""List available monitors."""
|
|
||||||
resp = ctx.obj.get_monitor_list()
|
|
||||||
|
|
||||||
if not resp.monitors:
|
if not resp.monitors:
|
||||||
out_console.print('No monitors found.')
|
console.out.print('No monitors found.')
|
||||||
return
|
return
|
||||||
|
|
||||||
monitors = sorted(
|
monitors = sorted(
|
||||||
@@ -32,39 +38,67 @@ def list_monitors(ctx: typer.Context):
|
|||||||
key=lambda m: m[0],
|
key=lambda m: m[0],
|
||||||
)
|
)
|
||||||
|
|
||||||
table = Table(title='Available Monitors', padding=(0, 2))
|
if not monitors:
|
||||||
table.add_column('Index', justify='center', style='cyan')
|
console.out.print('No monitors available.')
|
||||||
table.add_column('Name', style='cyan')
|
return
|
||||||
|
|
||||||
|
table = Table(
|
||||||
|
title='Available Monitors',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Index', justify='center'), justify='center', style=ctx.style.column
|
||||||
|
)
|
||||||
|
table.add_column(
|
||||||
|
Text('Name', justify='center'), justify='left', style=ctx.style.column
|
||||||
|
)
|
||||||
|
|
||||||
for index, monitor in monitors:
|
for index, monitor in monitors:
|
||||||
table.add_row(str(index), monitor)
|
table.add_row(str(index), monitor)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('open | o')
|
@app.command(name=['open', 'o'])
|
||||||
def open(
|
def open(
|
||||||
ctx: typer.Context,
|
source_name: Optional[str] = None,
|
||||||
monitor_index: Annotated[
|
/,
|
||||||
int,
|
monitor_index: Annotated[int, Parameter(validator=validators.Number(gte=0))] = 0,
|
||||||
typer.Option(help='Index of the monitor to open the projector on.'),
|
*,
|
||||||
] = 0,
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
source_name: Annotated[
|
|
||||||
str,
|
|
||||||
typer.Argument(
|
|
||||||
help='Name of the source to project. (optional, defaults to current scene)'
|
|
||||||
),
|
|
||||||
] = '',
|
|
||||||
):
|
):
|
||||||
"""Open a fullscreen projector for a source on a specific monitor."""
|
"""Open a fullscreen projector for a source on a specific monitor.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str, optional
|
||||||
|
The name of the source to project. If not provided, the current program scene will be used.
|
||||||
|
monitor_index : int, optional
|
||||||
|
The index of the monitor to open the projector on. Defaults to 0 (the primary monitor).
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
if not source_name:
|
if not source_name:
|
||||||
source_name = ctx.obj.get_current_program_scene().scene_name
|
source_name = ctx.client.get_current_program_scene().scene_name
|
||||||
|
|
||||||
ctx.obj.open_source_projector(
|
monitors = ctx.client.get_monitor_list().monitors
|
||||||
source_name=source_name,
|
for monitor in monitors:
|
||||||
monitor_index=monitor_index,
|
if monitor['monitorIndex'] == monitor_index:
|
||||||
)
|
ctx.client.open_source_projector(
|
||||||
|
source_name=source_name,
|
||||||
|
monitor_index=monitor_index,
|
||||||
|
)
|
||||||
|
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'Opened projector for source [bold]{source_name}[/] on monitor [bold]{monitor_index}[/].'
|
f'Opened projector for source {console.highlight(ctx, source_name)} on monitor {console.highlight(ctx, monitor["monitorName"])}.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Monitor with index [yellow]{monitor_index}[/yellow] not found. '
|
||||||
|
f'Use [yellow]obsws-cli projector ls-m[/yellow] to see available monitors.',
|
||||||
|
ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|||||||
@@ -3,127 +3,251 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Annotated, Optional
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
import typer
|
from cyclopts import App, Parameter
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from . import console
|
||||||
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='record', help='Commands for controlling OBS recording functionality.')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
def _get_recording_status(ctx: Context) -> tuple:
|
||||||
def main():
|
|
||||||
"""Control OBS recording functionality."""
|
|
||||||
|
|
||||||
|
|
||||||
def _get_recording_status(ctx: typer.Context) -> tuple:
|
|
||||||
"""Get recording status."""
|
"""Get recording status."""
|
||||||
resp = ctx.obj.get_record_status()
|
resp = ctx.client.get_record_status()
|
||||||
return resp.output_active, resp.output_paused
|
return resp.output_active, resp.output_paused
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command(name=['start', 's'])
|
||||||
def start(ctx: typer.Context):
|
def start(
|
||||||
"""Start recording."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Start recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
if active:
|
if active:
|
||||||
err_msg = 'Recording is already in progress, cannot start.'
|
err_msg = 'Recording is already in progress, cannot start.'
|
||||||
if paused:
|
if paused:
|
||||||
err_msg += ' Try resuming it.'
|
err_msg += ' Try resuming it.'
|
||||||
|
raise OBSWSCLIError(err_msg, ExitCode.ERROR)
|
||||||
|
|
||||||
err_console.print(err_msg)
|
ctx.client.start_record()
|
||||||
raise typer.Exit(1)
|
console.out.print('Recording started successfully.')
|
||||||
|
|
||||||
ctx.obj.start_record()
|
|
||||||
out_console.print('Recording started successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command(name=['stop', 'st'])
|
||||||
def stop(ctx: typer.Context):
|
def stop(
|
||||||
"""Stop recording."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Stop recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
active, _ = _get_recording_status(ctx)
|
active, _ = _get_recording_status(ctx)
|
||||||
if not active:
|
if not active:
|
||||||
err_console.print('Recording is not in progress, cannot stop.')
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
'Recording is not in progress, cannot stop.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.stop_record()
|
resp = ctx.client.stop_record()
|
||||||
out_console.print(f'Recording stopped successfully. Saved to: {resp.output_path}')
|
console.out.print(
|
||||||
|
f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(
|
||||||
"""Toggle recording."""
|
*,
|
||||||
resp = ctx.obj.toggle_record()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Toggle recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.toggle_record()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Recording started successfully.')
|
console.out.print('Recording started successfully.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Recording stopped successfully.')
|
console.out.print('Recording stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context):
|
def status(
|
||||||
"""Get recording status."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get recording status.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
active, paused = _get_recording_status(ctx)
|
active, paused = _get_recording_status(ctx)
|
||||||
if active:
|
if active:
|
||||||
if paused:
|
if paused:
|
||||||
out_console.print('Recording is in progress and paused.')
|
console.out.print('Recording is in progress and paused.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Recording is in progress.')
|
console.out.print('Recording is in progress.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Recording is not in progress.')
|
console.out.print('Recording is not in progress.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('resume | r')
|
@app.command(name=['resume', 'r'])
|
||||||
def resume(ctx: typer.Context):
|
def resume(
|
||||||
"""Resume recording."""
|
*,
|
||||||
active, paused = _get_recording_status(ctx)
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
if not active:
|
|
||||||
err_console.print('Recording is not in progress, cannot resume.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
if not paused:
|
|
||||||
err_console.print('Recording is in progress but not paused, cannot resume.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.resume_record()
|
|
||||||
out_console.print('Recording resumed successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('pause | p')
|
|
||||||
def pause(ctx: typer.Context):
|
|
||||||
"""Pause recording."""
|
|
||||||
active, paused = _get_recording_status(ctx)
|
|
||||||
if not active:
|
|
||||||
err_console.print('Recording is not in progress, cannot pause.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
if paused:
|
|
||||||
err_console.print('Recording is in progress but already paused, cannot pause.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.pause_record()
|
|
||||||
out_console.print('Recording paused successfully.')
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('directory | d')
|
|
||||||
def directory(
|
|
||||||
ctx: typer.Context,
|
|
||||||
record_directory: Annotated[
|
|
||||||
Optional[Path],
|
|
||||||
# Since the CLI and OBS may be running on different platforms,
|
|
||||||
# we won't validate the path here.
|
|
||||||
typer.Argument(
|
|
||||||
file_okay=False,
|
|
||||||
dir_okay=True,
|
|
||||||
help='Directory to set for recording.',
|
|
||||||
),
|
|
||||||
] = None,
|
|
||||||
):
|
):
|
||||||
"""Get or set the recording directory."""
|
"""Resume recording.
|
||||||
if record_directory is not None:
|
|
||||||
ctx.obj.set_record_directory(str(record_directory))
|
Parameters
|
||||||
out_console.print(f'Recording directory updated to: {record_directory}')
|
----------
|
||||||
else:
|
ctx: Context
|
||||||
out_console.print(
|
The context containing the OBS client and other settings.
|
||||||
f'Recording directory: {ctx.obj.get_record_directory().record_directory}'
|
|
||||||
|
"""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is not in progress, cannot resume.', ExitCode.ERROR
|
||||||
)
|
)
|
||||||
|
if not paused:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is in progress but not paused, cannot resume.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.client.resume_record()
|
||||||
|
console.out.print('Recording resumed successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['pause', 'p'])
|
||||||
|
def pause(
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Pause recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is not in progress, cannot pause.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
if paused:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is in progress but already paused, cannot pause.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.client.pause_record()
|
||||||
|
console.out.print('Recording paused successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['directory', 'd'])
|
||||||
|
def directory(
|
||||||
|
# Since the CLI and OBS may be running on different platforms,
|
||||||
|
# we won't validate the path here.
|
||||||
|
record_directory: Optional[Path] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get or set the recording directory.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
record_directory: Optional[Path]
|
||||||
|
The directory to set for recording. If not provided, the current recording directory is displayed.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if record_directory is not None:
|
||||||
|
ctx.client.set_record_directory(str(record_directory))
|
||||||
|
console.out.print(
|
||||||
|
f'Recording directory updated to: {console.highlight(ctx, record_directory)}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
resp = ctx.client.get_record_directory()
|
||||||
|
console.out.print(
|
||||||
|
f'Recording directory: {console.highlight(ctx, resp.record_directory)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['split', 'sp'])
|
||||||
|
def split(
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Split the current recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
console.err.print('Recording is not in progress, cannot split.')
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is not in progress, cannot split.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
if paused:
|
||||||
|
raise OBSWSCLIError('Recording is paused, cannot split.', ExitCode.ERROR)
|
||||||
|
|
||||||
|
ctx.client.split_record_file()
|
||||||
|
console.out.print('Recording split successfully.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['chapter', 'ch'])
|
||||||
|
def chapter(
|
||||||
|
chapter_name: Optional[str] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Create a chapter in the current recording.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
chapter_name: Optional[str]
|
||||||
|
The name of the chapter to create. If not provided, an unnamed chapter is created.
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
active, paused = _get_recording_status(ctx)
|
||||||
|
if not active:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is not in progress, cannot create chapter.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
if paused:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Recording is paused, cannot create chapter.', ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.client.create_record_chapter(chapter_name)
|
||||||
|
console.out.print(
|
||||||
|
f'Chapter {console.highlight(ctx, chapter_name or "unnamed")} created successfully.'
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,66 +1,113 @@
|
|||||||
"""module containing commands for manipulating the replay buffer in OBS."""
|
"""module containing commands for manipulating the replay buffer in OBS."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from cyclopts import App, Parameter
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
from . import console
|
||||||
out_console = Console()
|
from .context import Context
|
||||||
err_console = Console(stderr=True)
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
|
app = App(
|
||||||
|
name='replaybuffer', help='Commands for controlling the replay buffer in OBS.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['start', 's'])
|
||||||
def main():
|
def start(
|
||||||
"""Control profiles in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Start the replay buffer.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
@app.command('start | s')
|
"""
|
||||||
def start(ctx: typer.Context):
|
resp = ctx.client.get_replay_buffer_status()
|
||||||
"""Start the replay buffer."""
|
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
err_console.print('Replay buffer is already active.')
|
raise OBSWSCLIError('Replay buffer is already active.', ExitCode.ERROR)
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.start_replay_buffer()
|
ctx.client.start_replay_buffer()
|
||||||
out_console.print('Replay buffer started.')
|
console.out.print('Replay buffer started.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command(name=['stop', 'st'])
|
||||||
def stop(ctx: typer.Context):
|
def stop(
|
||||||
"""Stop the replay buffer."""
|
*,
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Stop the replay buffer.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_replay_buffer_status()
|
||||||
if not resp.output_active:
|
if not resp.output_active:
|
||||||
err_console.print('Replay buffer is not active.')
|
raise OBSWSCLIError('Replay buffer is not active.', ExitCode.ERROR)
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.stop_replay_buffer()
|
ctx.client.stop_replay_buffer()
|
||||||
out_console.print('Replay buffer stopped.')
|
console.out.print('Replay buffer stopped.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(
|
||||||
"""Toggle the replay buffer."""
|
*,
|
||||||
resp = ctx.obj.toggle_replay_buffer()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Toggle the replay buffer.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.toggle_replay_buffer()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Replay buffer is active.')
|
console.out.print('Replay buffer is active.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Replay buffer is not active.')
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context):
|
def status(
|
||||||
"""Get the status of the replay buffer."""
|
*,
|
||||||
resp = ctx.obj.get_replay_buffer_status()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the status of the replay buffer.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_replay_buffer_status()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Replay buffer is active.')
|
console.out.print('Replay buffer is active.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Replay buffer is not active.')
|
console.out.print('Replay buffer is not active.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('save | sv')
|
@app.command(name=['save', 'sv'])
|
||||||
def save(ctx: typer.Context):
|
def save(
|
||||||
"""Save the replay buffer."""
|
*,
|
||||||
ctx.obj.save_replay_buffer()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print('Replay buffer saved.')
|
):
|
||||||
|
"""Save the replay buffer.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx: Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.save_replay_buffer()
|
||||||
|
console.out.print('Replay buffer saved.')
|
||||||
|
|||||||
@@ -2,86 +2,150 @@
|
|||||||
|
|
||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import typer
|
from cyclopts import App, Parameter
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
from rich.text import Text
|
||||||
|
|
||||||
from . import validate
|
from . import console, util, validate
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='scene', help='Commands for managing OBS scenes')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control OBS scenes."""
|
uuid: bool = False,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""List all scenes.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
uuid : bool
|
||||||
|
Show UUIDs of scenes.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
@app.command('list | ls')
|
"""
|
||||||
def list(ctx: typer.Context):
|
resp = ctx.client.get_scene_list()
|
||||||
"""List all scenes."""
|
|
||||||
resp = ctx.obj.get_scene_list()
|
|
||||||
scenes = (
|
scenes = (
|
||||||
(scene.get('sceneName'), scene.get('sceneUuid'))
|
(scene.get('sceneName'), scene.get('sceneUuid'))
|
||||||
for scene in reversed(resp.scenes)
|
for scene in reversed(resp.scenes)
|
||||||
)
|
)
|
||||||
|
|
||||||
table = Table(title='Scenes', padding=(0, 2))
|
if not scenes:
|
||||||
for column in ('Scene Name', 'UUID'):
|
console.out.print('No scenes found.')
|
||||||
table.add_column(column, justify='left', style='cyan')
|
return
|
||||||
|
|
||||||
|
active_scene = ctx.client.get_current_program_scene().scene_name
|
||||||
|
|
||||||
|
table = Table(title='Scenes', padding=(0, 2), border_style=ctx.style.border)
|
||||||
|
if uuid:
|
||||||
|
columns = [
|
||||||
|
(Text('Scene Name', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Active', justify='center'), 'center', None),
|
||||||
|
(Text('UUID', justify='center'), 'left', ctx.style.column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
(Text('Scene Name', justify='center'), 'left', ctx.style.column),
|
||||||
|
(Text('Active', justify='center'), 'center', None),
|
||||||
|
]
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
for scene_name, scene_uuid in scenes:
|
for scene_name, scene_uuid in scenes:
|
||||||
table.add_row(
|
if uuid:
|
||||||
scene_name,
|
table.add_row(
|
||||||
scene_uuid,
|
scene_name,
|
||||||
|
util.check_mark(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),
|
||||||
|
)
|
||||||
|
|
||||||
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['current', 'get'])
|
||||||
|
def current(
|
||||||
|
preview: bool = False,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the current program scene or preview scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
preview : bool
|
||||||
|
If True, get the preview scene instead of the program scene.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if preview and not validate.studio_mode_enabled(ctx):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'Studio mode is not enabled, cannot get preview scene.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
)
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
|
||||||
def current(
|
|
||||||
ctx: typer.Context,
|
|
||||||
preview: Annotated[
|
|
||||||
bool, typer.Option(help='Get the preview scene instead of the program scene')
|
|
||||||
] = False,
|
|
||||||
):
|
|
||||||
"""Get the current program scene or preview scene."""
|
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
|
||||||
err_console.print('Studio mode is not enabled, cannot get preview scene.')
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if preview:
|
if preview:
|
||||||
resp = ctx.obj.get_current_preview_scene()
|
resp = ctx.client.get_current_preview_scene()
|
||||||
out_console.print(resp.current_preview_scene_name)
|
console.out.print(
|
||||||
|
f'Current Preview Scene: {console.highlight(ctx, resp.current_preview_scene_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
resp = ctx.obj.get_current_program_scene()
|
resp = ctx.client.get_current_program_scene()
|
||||||
out_console.print(resp.current_program_scene_name)
|
console.out.print(
|
||||||
|
f'Current Program Scene: {console.highlight(ctx, resp.current_program_scene_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command(name=['switch', 'set'])
|
||||||
def switch(
|
def switch(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
preview: Annotated[
|
/,
|
||||||
bool,
|
preview: bool = False,
|
||||||
typer.Option(help='Switch to the preview scene instead of the program scene'),
|
*,
|
||||||
] = False,
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Switch to a scene."""
|
"""Switch to a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene to switch to.
|
||||||
|
preview : bool
|
||||||
|
If True, switch to the preview scene instead of the program scene.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
if preview and not validate.studio_mode_enabled(ctx):
|
if preview and not validate.studio_mode_enabled(ctx):
|
||||||
err_console.print('Studio mode is not enabled, cannot set the preview scene.')
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
'Studio mode is not enabled, cannot switch to preview scene.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
if preview:
|
if preview:
|
||||||
ctx.obj.set_current_preview_scene(scene_name)
|
ctx.client.set_current_preview_scene(scene_name)
|
||||||
out_console.print(f'Switched to preview scene: {scene_name}')
|
console.out.print(
|
||||||
|
f'Switched to preview scene: {console.highlight(ctx, scene_name)}'
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
ctx.obj.set_current_program_scene(scene_name)
|
ctx.client.set_current_program_scene(scene_name)
|
||||||
out_console.print(f'Switched to program scene: {scene_name}')
|
console.out.print(
|
||||||
|
f'Switched to program scene: {console.highlight(ctx, scene_name)}'
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,69 +1,133 @@
|
|||||||
"""module containing commands for manipulating scene collections."""
|
"""module containing commands for manipulating scene collections."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
from cyclopts import App, Parameter
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
|
||||||
from . import validate
|
from . import console, validate
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(
|
||||||
out_console = Console()
|
name='scenecollection', help='Commands for controlling scene collections in OBS.'
|
||||||
err_console = Console(stderr=True)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control scene collections in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""List all scene collections.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
@app.command('list | ls')
|
"""
|
||||||
def list(ctx: typer.Context):
|
resp = ctx.client.get_scene_collection_list()
|
||||||
"""List all scene collections."""
|
|
||||||
resp = ctx.obj.get_scene_collection_list()
|
|
||||||
|
|
||||||
table = Table(title='Scene Collections', padding=(0, 2))
|
table = Table(
|
||||||
table.add_column('Scene Collection Name', justify='left', style='cyan')
|
title='Scene Collections',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
table.add_column('Scene Collection Name', justify='left', style=ctx.style.column)
|
||||||
|
|
||||||
|
if not resp.scene_collections:
|
||||||
|
console.out.print('No scene collections found.')
|
||||||
|
return
|
||||||
|
|
||||||
for scene_collection_name in resp.scene_collections:
|
for scene_collection_name in resp.scene_collections:
|
||||||
table.add_row(scene_collection_name)
|
table.add_row(scene_collection_name)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command(name=['current', 'get'])
|
||||||
def current(ctx: typer.Context):
|
def current(
|
||||||
"""Get the current scene collection."""
|
*,
|
||||||
resp = ctx.obj.get_scene_collection_list()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print(resp.current_scene_collection_name)
|
):
|
||||||
|
"""Get the current scene collection.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_scene_collection_list()
|
||||||
|
console.out.print(
|
||||||
|
f'Current scene collection: {console.highlight(ctx, resp.current_scene_collection_name)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command(name=['switch', 'set'])
|
||||||
def switch(ctx: typer.Context, scene_collection_name: str):
|
def switch(
|
||||||
"""Switch to a scene collection."""
|
scene_collection_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Switch to a scene collection.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_collection_name : str
|
||||||
|
The name of the scene collection to switch to.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
||||||
err_console.print(f"Scene collection '{scene_collection_name}' not found.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
current_scene_collection = (
|
current_scene_collection = (
|
||||||
ctx.obj.get_scene_collection_list().current_scene_collection_name
|
ctx.client.get_scene_collection_list().current_scene_collection_name
|
||||||
)
|
)
|
||||||
if scene_collection_name == current_scene_collection:
|
if scene_collection_name == current_scene_collection:
|
||||||
err_console.print(
|
raise OBSWSCLIError(
|
||||||
f'Scene collection "{scene_collection_name}" is already active.'
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] is already active.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
)
|
)
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
ctx.obj.set_current_scene_collection(scene_collection_name)
|
ctx.client.set_current_scene_collection(scene_collection_name)
|
||||||
out_console.print(f"Switched to scene collection '{scene_collection_name}'")
|
console.out.print(
|
||||||
|
f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.command('create | new')
|
@app.command(name=['create', 'new'])
|
||||||
def create(ctx: typer.Context, scene_collection_name: str):
|
def create(
|
||||||
"""Create a new scene collection."""
|
scene_collection_name: str,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Create a new scene collection.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_collection_name : str
|
||||||
|
The name of the scene collection to create.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
|
||||||
err_console.print(f"Scene collection '{scene_collection_name}' already exists.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.create_scene_collection(scene_collection_name)
|
ctx.client.create_scene_collection(scene_collection_name)
|
||||||
out_console.print(f'Created scene collection {scene_collection_name}')
|
console.out.print(
|
||||||
|
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,42 +1,50 @@
|
|||||||
"""module containing commands for manipulating items in scenes."""
|
"""module containing commands for manipulating items in scenes."""
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from typing import Annotated, Optional
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
import obsws_python as obsws
|
from cyclopts import App, Parameter
|
||||||
import typer
|
|
||||||
from rich.console import Console
|
|
||||||
from rich.table import Table
|
from rich.table import Table
|
||||||
|
|
||||||
from . import validate
|
from . import console, util, validate
|
||||||
from .alias import AliasGroup
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = App(name='sceneitem', help='Commands for controlling scene items in OBS.')
|
||||||
out_console = Console()
|
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['list', 'ls'])
|
||||||
def main():
|
def list_(
|
||||||
"""Control items in OBS scenes."""
|
scene_name: Optional[str] = None,
|
||||||
|
/,
|
||||||
|
uuid: bool = False,
|
||||||
@app.command('list | ls')
|
*,
|
||||||
def list(
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str = typer.Argument(
|
|
||||||
None, help='Scene name (optional, defaults to current scene)'
|
|
||||||
),
|
|
||||||
):
|
):
|
||||||
"""List all items in a scene."""
|
"""List all items in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str, optional
|
||||||
|
The name of the scene to list items for. If not provided, the current program scene
|
||||||
|
will be used.
|
||||||
|
uuid : bool
|
||||||
|
Show UUIDs of scene items.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
if not scene_name:
|
if not scene_name:
|
||||||
scene_name = ctx.obj.get_current_program_scene().scene_name
|
scene_name = ctx.client.get_current_program_scene().scene_name
|
||||||
|
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
|
||||||
raise typer.Exit(1)
|
raise OBSWSCLIError(
|
||||||
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
items = sorted(
|
items = sorted(
|
||||||
(
|
(
|
||||||
(
|
(
|
||||||
@@ -44,6 +52,7 @@ def list(
|
|||||||
item.get('sourceName'),
|
item.get('sourceName'),
|
||||||
item.get('isGroup'),
|
item.get('isGroup'),
|
||||||
item.get('sceneItemEnabled'),
|
item.get('sceneItemEnabled'),
|
||||||
|
item.get('sourceUuid', 'N/A'), # Include source UUID
|
||||||
)
|
)
|
||||||
for item in resp.scene_items
|
for item in resp.scene_items
|
||||||
),
|
),
|
||||||
@@ -51,213 +60,284 @@ def list(
|
|||||||
)
|
)
|
||||||
|
|
||||||
if not items:
|
if not items:
|
||||||
out_console.print(f"No items found in scene '{scene_name}'.")
|
console.out.print(
|
||||||
raise typer.Exit()
|
f'No items found in scene {console.highlight(ctx, scene_name)}.'
|
||||||
|
|
||||||
table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
|
|
||||||
for column in ('Item ID', 'Item Name', 'In Group', 'Enabled'):
|
|
||||||
table.add_column(
|
|
||||||
column, justify='left' if column == 'Item Name' else 'center', style='cyan'
|
|
||||||
)
|
)
|
||||||
|
return
|
||||||
|
|
||||||
for item_id, item_name, is_group, is_enabled in items:
|
table = Table(
|
||||||
|
title=f'Items in Scene: {scene_name}',
|
||||||
|
padding=(0, 2),
|
||||||
|
border_style=ctx.style.border,
|
||||||
|
)
|
||||||
|
if uuid:
|
||||||
|
columns = [
|
||||||
|
('Item ID', 'center', ctx.style.column),
|
||||||
|
('Item Name', 'left', ctx.style.column),
|
||||||
|
('In Group', 'left', ctx.style.column),
|
||||||
|
('Enabled', 'center', None),
|
||||||
|
('UUID', 'left', ctx.style.column),
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
columns = [
|
||||||
|
('Item ID', 'center', ctx.style.column),
|
||||||
|
('Item Name', 'left', ctx.style.column),
|
||||||
|
('In Group', 'left', ctx.style.column),
|
||||||
|
('Enabled', 'center', None),
|
||||||
|
]
|
||||||
|
# Add columns to the table
|
||||||
|
for heading, justify, style in columns:
|
||||||
|
table.add_column(heading, justify=justify, style=style)
|
||||||
|
|
||||||
|
for item_id, item_name, is_group, is_enabled, source_uuid in items:
|
||||||
if is_group:
|
if is_group:
|
||||||
resp = ctx.obj.get_group_scene_item_list(item_name)
|
resp = ctx.client.get_group_scene_item_list(item_name)
|
||||||
group_items = sorted(
|
group_items = sorted(
|
||||||
(
|
(
|
||||||
(
|
(
|
||||||
gi.get('sceneItemId'),
|
gi.get('sceneItemId'),
|
||||||
gi.get('sourceName'),
|
gi.get('sourceName'),
|
||||||
gi.get('sceneItemEnabled'),
|
gi.get('sceneItemEnabled'),
|
||||||
|
gi.get('sourceUuid', 'N/A'), # Include source UUID
|
||||||
)
|
)
|
||||||
for gi in resp.scene_items
|
for gi in resp.scene_items
|
||||||
),
|
),
|
||||||
key=lambda x: x[0], # Sort by sceneItemId
|
key=lambda x: x[0], # Sort by sceneItemId
|
||||||
)
|
)
|
||||||
for group_item_id, group_item_name, group_item_enabled in group_items:
|
for (
|
||||||
table.add_row(
|
group_item_id,
|
||||||
str(group_item_id),
|
group_item_name,
|
||||||
group_item_name,
|
group_item_enabled,
|
||||||
item_name,
|
group_item_source_uuid,
|
||||||
':white_heavy_check_mark:'
|
) in group_items:
|
||||||
if is_enabled and group_item_enabled
|
if uuid:
|
||||||
else ':x:',
|
table.add_row(
|
||||||
)
|
str(group_item_id),
|
||||||
|
group_item_name,
|
||||||
|
item_name,
|
||||||
|
util.check_mark(is_enabled and group_item_enabled),
|
||||||
|
group_item_source_uuid,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
str(group_item_id),
|
||||||
|
group_item_name,
|
||||||
|
item_name,
|
||||||
|
util.check_mark(is_enabled and group_item_enabled),
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
table.add_row(
|
if uuid:
|
||||||
str(item_id),
|
table.add_row(
|
||||||
item_name,
|
str(item_id),
|
||||||
'',
|
item_name,
|
||||||
':white_heavy_check_mark:' if is_enabled else ':x:',
|
'',
|
||||||
)
|
util.check_mark(is_enabled),
|
||||||
|
source_uuid,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
table.add_row(
|
||||||
|
str(item_id),
|
||||||
|
item_name,
|
||||||
|
'',
|
||||||
|
util.check_mark(is_enabled),
|
||||||
|
)
|
||||||
|
|
||||||
out_console.print(table)
|
console.out.print(table)
|
||||||
|
|
||||||
|
|
||||||
def _validate_scene_name_and_item_name(
|
def _validate_sources(
|
||||||
func: Callable,
|
ctx: Context,
|
||||||
|
scene_name: str,
|
||||||
|
item_name: str,
|
||||||
|
group: Optional[str] = None,
|
||||||
):
|
):
|
||||||
"""Validate the scene name and item name."""
|
"""Validate the scene name and item name."""
|
||||||
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Scene [yellow]{scene_name}[/yellow] not found.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
def wrapper(
|
if group:
|
||||||
ctx: typer.Context,
|
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
||||||
scene_name: str,
|
raise OBSWSCLIError(
|
||||||
item_name: str,
|
f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
|
||||||
group: Optional[str] = None,
|
exit_code=ExitCode.ERROR,
|
||||||
):
|
)
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
else:
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
||||||
raise typer.Exit(1)
|
raise OBSWSCLIError(
|
||||||
|
f'Item [yellow]{item_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow]. Is the item in a group? '
|
||||||
if group:
|
f'If so use the [yellow]--group[/yellow] option to specify the parent group.\n'
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
'Use [yellow]obsws-cli sceneitem ls[/yellow] for a list of items in the scene.',
|
||||||
err_console.print(
|
exit_code=ExitCode.ERROR,
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
)
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
else:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
|
||||||
err_console.print(
|
|
||||||
f"Item '{item_name}' not found in scene '{scene_name}'."
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
return func(ctx, scene_name, item_name, group)
|
|
||||||
|
|
||||||
return wrapper
|
|
||||||
|
|
||||||
|
|
||||||
def _get_scene_name_and_item_id(
|
def _get_scene_name_and_item_id(
|
||||||
ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
|
ctx: Context,
|
||||||
|
scene_name: str,
|
||||||
|
item_name: str,
|
||||||
|
group: Optional[str] = None,
|
||||||
):
|
):
|
||||||
"""Get the scene name and item ID for the given scene and item name."""
|
"""Get the scene name and item ID for the given scene and item name."""
|
||||||
if group:
|
if group:
|
||||||
resp = ctx.obj.get_group_scene_item_list(group)
|
resp = ctx.client.get_group_scene_item_list(group)
|
||||||
for item in resp.scene_items:
|
for item in resp.scene_items:
|
||||||
if item.get('sourceName') == item_name:
|
if item.get('sourceName') == item_name:
|
||||||
scene_name = group
|
scene_name = group
|
||||||
scene_item_id = item.get('sceneItemId')
|
scene_item_id = item.get('sceneItemId')
|
||||||
break
|
break
|
||||||
else:
|
else:
|
||||||
err_console.print(f"Item '{item_name}' not found in group '{group}'.")
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
try:
|
resp = ctx.client.get_scene_item_id(scene_name, item_name)
|
||||||
resp = ctx.obj.get_scene_item_id(scene_name, item_name)
|
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
|
||||||
if e.code == 600:
|
|
||||||
err_console.print(
|
|
||||||
f"Item '{item_name}' not found in scene '{scene_name}'. Is the item in a group? "
|
|
||||||
'If so use the --group option to specify the parent group. '
|
|
||||||
'See `obsws-cli sceneitem list` for a list of items in the scene.'
|
|
||||||
)
|
|
||||||
raise typer.Exit(1)
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
scene_item_id = resp.scene_item_id
|
scene_item_id = resp.scene_item_id
|
||||||
|
|
||||||
return scene_name, scene_item_id
|
return scene_name, scene_item_id
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command(name=['show', 'sh'])
|
||||||
@app.command('show | sh')
|
|
||||||
def show(
|
def show(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
/,
|
||||||
|
group: Optional[str] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Show an item in a scene."""
|
"""Show an item in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene the item is in.
|
||||||
|
item_name : str
|
||||||
|
The name of the item to show in the scene.
|
||||||
|
group : str, optional
|
||||||
|
The name of the parent group the item is in, if applicable.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
_validate_sources(ctx, scene_name, item_name, group)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
ctx, scene_name, item_name, group
|
ctx, scene_name, item_name, group
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
enabled=True,
|
enabled=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been shown.")
|
console.out.print(
|
||||||
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command(name=['hide', 'h'])
|
||||||
@app.command('hide | h')
|
|
||||||
def hide(
|
def hide(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
/,
|
||||||
|
group: Optional[str] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Hide an item in a scene."""
|
"""Hide an item in a scene.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
scene_name : str
|
||||||
|
The name of the scene the item is in.
|
||||||
|
item_name : str
|
||||||
|
The name of the item to hide in the scene.
|
||||||
|
group : str, optional
|
||||||
|
The name of the parent group the item is in, if applicable.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
_validate_sources(ctx, scene_name, item_name, group)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
ctx, scene_name, item_name, group
|
ctx, scene_name, item_name, group
|
||||||
)
|
)
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
enabled=False,
|
enabled=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command(name=['toggle', 'tg'])
|
||||||
@app.command('toggle | tg')
|
|
||||||
def toggle(
|
def toggle(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
/,
|
||||||
|
group: Optional[str] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Toggle an item in a scene."""
|
"""Toggle an item in a scene.
|
||||||
if not validate.scene_in_scenes(ctx, scene_name):
|
|
||||||
err_console.print(f"Scene '{scene_name}' not found.")
|
|
||||||
raise typer.Exit(1)
|
|
||||||
|
|
||||||
if group:
|
Parameters
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
----------
|
||||||
err_console.print(
|
scene_name : str
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
The name of the scene the item is in.
|
||||||
)
|
item_name : str
|
||||||
raise typer.Exit(1)
|
The name of the item to toggle in the scene.
|
||||||
else:
|
group : str, optional
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
The name of the parent group the item is in, if applicable.
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
ctx : Context
|
||||||
raise typer.Exit(1)
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
_validate_sources(ctx, scene_name, item_name, group)
|
||||||
|
|
||||||
|
old_scene_name = scene_name
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
ctx, scene_name, item_name, group
|
ctx, scene_name, item_name, group
|
||||||
)
|
)
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
enabled = ctx.client.get_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
)
|
)
|
||||||
new_state = not enabled.scene_item_enabled
|
new_state = not enabled.scene_item_enabled
|
||||||
|
|
||||||
ctx.obj.set_scene_item_enabled(
|
ctx.client.set_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
enabled=new_state,
|
enabled=new_state,
|
||||||
@@ -265,12 +345,14 @@ def toggle(
|
|||||||
|
|
||||||
if group:
|
if group:
|
||||||
if new_state:
|
if new_state:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
@@ -278,123 +360,135 @@ def toggle(
|
|||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
if new_state:
|
if new_state:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been shown."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command(name=['visible', 'v'])
|
||||||
@app.command('visible | v')
|
|
||||||
def visible(
|
def visible(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
/,
|
||||||
|
group: Optional[str] = None,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
):
|
):
|
||||||
"""Check if an item in a scene is visible."""
|
"""Check if an item in a scene is visible.
|
||||||
if group:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
Parameters
|
||||||
err_console.print(
|
----------
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
scene_name : str
|
||||||
)
|
The name of the scene the item is in.
|
||||||
raise typer.Exit(1)
|
item_name : str
|
||||||
else:
|
The name of the item to check visibility in the scene.
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
group : str, optional
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
The name of the parent group the item is in, if applicable.
|
||||||
raise typer.Exit(1)
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
_validate_sources(ctx, scene_name, item_name, group)
|
||||||
|
|
||||||
old_scene_name = scene_name
|
old_scene_name = scene_name
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
ctx, scene_name, item_name, group
|
ctx, scene_name, item_name, group
|
||||||
)
|
)
|
||||||
|
|
||||||
enabled = ctx.obj.get_scene_item_enabled(
|
enabled = ctx.client.get_scene_item_enabled(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} '
|
||||||
|
f'is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@_validate_scene_name_and_item_name
|
@app.command(name=['transform', 't'])
|
||||||
@app.command('transform | t')
|
|
||||||
def transform(
|
def transform(
|
||||||
ctx: typer.Context,
|
|
||||||
scene_name: str,
|
scene_name: str,
|
||||||
item_name: str,
|
item_name: str,
|
||||||
group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
|
/,
|
||||||
alignment: Annotated[
|
group: Optional[str] = None,
|
||||||
Optional[int], typer.Option(help='Alignment of the item in the scene')
|
alignment: Optional[int] = None,
|
||||||
] = None,
|
bounds_alignment: Optional[int] = None,
|
||||||
bounds_alignment: Annotated[
|
bounds_height: Optional[float] = None,
|
||||||
Optional[int], typer.Option(help='Bounds alignment of the item in the scene')
|
bounds_type: Optional[str] = None,
|
||||||
] = None,
|
bounds_width: Optional[float] = None,
|
||||||
bounds_height: Annotated[
|
crop_to_bounds: Optional[bool] = None,
|
||||||
Optional[float], typer.Option(help='Height of the item in the scene')
|
crop_bottom: Optional[float] = None,
|
||||||
] = None,
|
crop_left: Optional[float] = None,
|
||||||
bounds_type: Annotated[
|
crop_right: Optional[float] = None,
|
||||||
Optional[str], typer.Option(help='Type of bounds for the item in the scene')
|
crop_top: Optional[float] = None,
|
||||||
] = None,
|
position_x: Optional[float] = None,
|
||||||
bounds_width: Annotated[
|
position_y: Optional[float] = None,
|
||||||
Optional[float], typer.Option(help='Width of the item in the scene')
|
rotation: Optional[float] = None,
|
||||||
] = None,
|
scale_x: Optional[float] = None,
|
||||||
crop_to_bounds: Annotated[
|
scale_y: Optional[float] = None,
|
||||||
Optional[bool], typer.Option(help='Crop the item to the bounds')
|
*,
|
||||||
] = None,
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
crop_bottom: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Bottom crop of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
crop_left: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Left crop of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
crop_right: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Right crop of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
crop_top: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Top crop of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
position_x: Annotated[
|
|
||||||
Optional[float], typer.Option(help='X position of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
position_y: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Y position of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
rotation: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Rotation of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
scale_x: Annotated[
|
|
||||||
Optional[float], typer.Option(help='X scale of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
scale_y: Annotated[
|
|
||||||
Optional[float], typer.Option(help='Y scale of the item in the scene')
|
|
||||||
] = None,
|
|
||||||
):
|
):
|
||||||
"""Set the transform of an item in a scene."""
|
"""Set the transform of an item in a scene.
|
||||||
if group:
|
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, group):
|
Parameters
|
||||||
err_console.print(
|
----------
|
||||||
f"Parent group '{group}' not found in scene '{scene_name}'."
|
scene_name : str
|
||||||
)
|
The name of the scene the item is in.
|
||||||
raise typer.Exit(1)
|
item_name : str
|
||||||
else:
|
The name of the item to transform in the scene.
|
||||||
if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
|
group : str, optional
|
||||||
err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
|
The name of the parent group the item is in, if applicable.
|
||||||
raise typer.Exit(1)
|
alignment : int, optional
|
||||||
|
Alignment of the item in the scene.
|
||||||
|
bounds_alignment : int, optional
|
||||||
|
Bounds alignment of the item in the scene.
|
||||||
|
bounds_height : float, optional
|
||||||
|
Height of the item in the scene.
|
||||||
|
bounds_type : str, optional
|
||||||
|
Type of bounds for the item in the scene.
|
||||||
|
bounds_width : float, optional
|
||||||
|
Width of the item in the scene.
|
||||||
|
crop_to_bounds : bool, optional
|
||||||
|
Crop the item to the bounds.
|
||||||
|
crop_bottom : float, optional
|
||||||
|
Bottom crop of the item in the scene.
|
||||||
|
crop_left : float, optional
|
||||||
|
Left crop of the item in the scene.
|
||||||
|
crop_right : float, optional
|
||||||
|
Right crop of the item in the scene.
|
||||||
|
crop_top : float, optional
|
||||||
|
Top crop of the item in the scene.
|
||||||
|
position_x : float, optional
|
||||||
|
X position of the item in the scene.
|
||||||
|
position_y : float, optional
|
||||||
|
Y position of the item in the scene.
|
||||||
|
rotation : float, optional
|
||||||
|
Rotation of the item in the scene.
|
||||||
|
scale_x : float, optional
|
||||||
|
X scale of the item in the scene.
|
||||||
|
scale_y : float, optional
|
||||||
|
Y scale of the item in the scene.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and configuration.
|
||||||
|
|
||||||
|
"""
|
||||||
|
_validate_sources(ctx, scene_name, item_name, group)
|
||||||
|
|
||||||
old_scene_name = scene_name
|
old_scene_name = scene_name
|
||||||
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
scene_name, scene_item_id = _get_scene_name_and_item_id(
|
||||||
@@ -434,24 +528,27 @@ def transform(
|
|||||||
transform['scaleY'] = scale_y
|
transform['scaleY'] = scale_y
|
||||||
|
|
||||||
if not transform:
|
if not transform:
|
||||||
err_console.print('No transform options provided.')
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
'No transform options provided. Use at least one of the transform options.',
|
||||||
|
exit_code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
transform = ctx.obj.set_scene_item_transform(
|
transform = ctx.client.set_scene_item_transform(
|
||||||
scene_name=scene_name,
|
scene_name=scene_name,
|
||||||
item_id=int(scene_item_id),
|
item_id=int(scene_item_id),
|
||||||
transform=transform,
|
transform=transform,
|
||||||
)
|
)
|
||||||
|
|
||||||
if group:
|
if group:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' has been transformed."
|
f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
|
||||||
|
f'in scene {console.highlight(ctx, old_scene_name)} has been transformed.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# If not in a parent group, just show the scene name
|
# If not in a parent group, just show the scene name
|
||||||
# This is to avoid confusion with the parent group name
|
# This is to avoid confusion with the parent group name
|
||||||
# which is not the same as the scene name
|
# which is not the same as the scene name
|
||||||
# and is not needed in this case
|
# and is not needed in this case
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f"Item '{item_name}' in scene '{scene_name}' has been transformed."
|
f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been transformed.'
|
||||||
)
|
)
|
||||||
|
|||||||
75
obsws_cli/screenshot.py
Normal file
75
obsws_cli/screenshot.py
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
"""module for taking screenshots using OBS WebSocket API."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import obsws_python as obsws
|
||||||
|
from cyclopts import App, Parameter, validators
|
||||||
|
|
||||||
|
from . import console
|
||||||
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
|
app = App(name='screenshot', help='Commands for taking screenshots using OBS.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['save', 'sv'])
|
||||||
|
def save(
|
||||||
|
source_name: str,
|
||||||
|
# Since the CLI and OBS may be running on different platforms,
|
||||||
|
# we won't validate the path here.
|
||||||
|
output_path: Path,
|
||||||
|
/,
|
||||||
|
width: float = 1920,
|
||||||
|
height: float = 1080,
|
||||||
|
quality: Annotated[
|
||||||
|
float, Parameter(validator=validators.Number(gte=-1, lte=100))
|
||||||
|
] = -1.0,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Take a screenshot and save it to a file.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
source_name : str
|
||||||
|
Name of the source to take a screenshot of.
|
||||||
|
output_path : Path
|
||||||
|
Path to save the screenshot (must include file name and extension).
|
||||||
|
width : float
|
||||||
|
Width of the screenshot.
|
||||||
|
height : float
|
||||||
|
Height of the screenshot.
|
||||||
|
quality : float
|
||||||
|
Quality of the screenshot. A value of -1 uses the default quality.
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
ctx.client.save_source_screenshot(
|
||||||
|
name=source_name,
|
||||||
|
img_format=output_path.suffix.lstrip('.').lower(),
|
||||||
|
file_path=str(output_path),
|
||||||
|
width=width,
|
||||||
|
height=height,
|
||||||
|
quality=quality,
|
||||||
|
)
|
||||||
|
except obsws.error.OBSSDKRequestError as e:
|
||||||
|
match e.code:
|
||||||
|
case 403:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'The [yellow]image format[/yellow] (file extension) must be included in the file name, '
|
||||||
|
"for example: '/path/to/screenshot.png'.",
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
case 600:
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
'No source was found by the name of [yellow]{source_name}[/yellow]',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
case _:
|
||||||
|
raise
|
||||||
|
|
||||||
|
console.out.print(f'Screenshot saved to {console.highlight(ctx, output_path)}.')
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
"""module for settings management."""
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class Settings(BaseSettings):
|
|
||||||
"""Settings for the OBS WebSocket client."""
|
|
||||||
|
|
||||||
model_config = SettingsConfigDict(
|
|
||||||
env_file=(
|
|
||||||
'.env',
|
|
||||||
Path.home() / '.config' / 'obsws-cli' / 'obsws.env',
|
|
||||||
),
|
|
||||||
env_file_encoding='utf-8',
|
|
||||||
env_prefix='OBS_',
|
|
||||||
)
|
|
||||||
|
|
||||||
HOST: str = 'localhost'
|
|
||||||
PORT: int = 4455
|
|
||||||
PASSWORD: str = '' # No password by default
|
|
||||||
TIMEOUT: int = 5 # Timeout for requests in seconds
|
|
||||||
|
|
||||||
|
|
||||||
_settings = Settings().model_dump()
|
|
||||||
|
|
||||||
|
|
||||||
def get(key: str) -> str:
|
|
||||||
"""Get a setting by key."""
|
|
||||||
return _settings.get(key)
|
|
||||||
@@ -1,63 +1,104 @@
|
|||||||
"""module for controlling OBS stream functionality."""
|
"""module for controlling OBS stream functionality."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from cyclopts import App, Parameter
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
from . import console
|
||||||
out_console = Console()
|
from .context import Context
|
||||||
err_console = Console(stderr=True)
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
|
app = App(name='stream', help='Commands for controlling OBS stream functionality.')
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
def _get_streaming_status(ctx: Context) -> tuple:
|
||||||
def main():
|
|
||||||
"""Control OBS stream functionality."""
|
|
||||||
|
|
||||||
|
|
||||||
def _get_streaming_status(ctx: typer.Context) -> tuple:
|
|
||||||
"""Get streaming status."""
|
"""Get streaming status."""
|
||||||
resp = ctx.obj.get_stream_status()
|
resp = ctx.client.get_stream_status()
|
||||||
return resp.output_active, resp.output_duration
|
return resp.output_active, resp.output_duration
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command(name=['start', 's'])
|
||||||
def start(ctx: typer.Context):
|
def start(
|
||||||
"""Start streaming."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Start streaming.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
active, _ = _get_streaming_status(ctx)
|
active, _ = _get_streaming_status(ctx)
|
||||||
if active:
|
if active:
|
||||||
err_console.print('Streaming is already in progress, cannot start.')
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
'Streaming is already in progress, cannot start.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.start_stream()
|
ctx.client.start_stream()
|
||||||
out_console.print('Streaming started successfully.')
|
console.out.print('Streaming started successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | st')
|
@app.command(name=['stop', 'st'])
|
||||||
def stop(ctx: typer.Context):
|
def stop(
|
||||||
"""Stop streaming."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Stop streaming.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
active, _ = _get_streaming_status(ctx)
|
active, _ = _get_streaming_status(ctx)
|
||||||
if not active:
|
if not active:
|
||||||
err_console.print('Streaming is not in progress, cannot stop.')
|
raise OBSWSCLIError(
|
||||||
raise typer.Exit(1)
|
'Streaming is not in progress, cannot stop.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
ctx.obj.stop_stream()
|
ctx.client.stop_stream()
|
||||||
out_console.print('Streaming stopped successfully.')
|
console.out.print('Streaming stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def toggle(ctx: typer.Context):
|
def toggle(
|
||||||
"""Toggle streaming."""
|
*,
|
||||||
resp = ctx.obj.toggle_stream()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Toggle streaming.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.toggle_stream()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Streaming started successfully.')
|
console.out.print('Streaming started successfully.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Streaming stopped successfully.')
|
console.out.print('Streaming stopped successfully.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context):
|
def status(
|
||||||
"""Get streaming status."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get streaming status.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
active, duration = _get_streaming_status(ctx)
|
active, duration = _get_streaming_status(ctx)
|
||||||
if active:
|
if active:
|
||||||
if duration > 0:
|
if duration > 0:
|
||||||
@@ -65,19 +106,19 @@ def status(ctx: typer.Context):
|
|||||||
minutes = int(seconds // 60)
|
minutes = int(seconds // 60)
|
||||||
seconds = int(seconds % 60)
|
seconds = int(seconds % 60)
|
||||||
if minutes > 0:
|
if minutes > 0:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'Streaming is in progress for {minutes} minutes and {seconds} seconds.'
|
f'Streaming is in progress for {minutes} minutes and {seconds} seconds.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
if seconds > 0:
|
if seconds > 0:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
f'Streaming is in progress for {seconds} seconds.'
|
f'Streaming is in progress for {seconds} seconds.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print(
|
console.out.print(
|
||||||
'Streaming is in progress for less than a second.'
|
'Streaming is in progress for less than a second.'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
out_console.print('Streaming is in progress.')
|
console.out.print('Streaming is in progress.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Streaming is not in progress.')
|
console.out.print('Streaming is not in progress.')
|
||||||
|
|||||||
@@ -1,51 +1,86 @@
|
|||||||
"""module containing commands for manipulating studio mode in OBS."""
|
"""module containing commands for manipulating studio mode in OBS."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from cyclopts import App, Parameter
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
from . import console
|
||||||
out_console = Console()
|
from .context import Context
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
app = App(name='studiomode', help='Commands for controlling studio mode in OBS.')
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['enable', 'on'])
|
||||||
def main():
|
def enable(
|
||||||
"""Control studio mode in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Enable studio mode.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.set_studio_mode_enabled(True)
|
||||||
|
console.out.print('Studio mode has been enabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('enable | on')
|
@app.command(name=['disable', 'off'])
|
||||||
def enable(ctx: typer.Context):
|
def disable(
|
||||||
"""Enable studio mode."""
|
*,
|
||||||
ctx.obj.set_studio_mode_enabled(True)
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print('Studio mode has been enabled.')
|
):
|
||||||
|
"""Disable studio mode.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.set_studio_mode_enabled(False)
|
||||||
|
console.out.print('Studio mode has been disabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('disable | off')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def disable(ctx: typer.Context):
|
def toggle(
|
||||||
"""Disable studio mode."""
|
*,
|
||||||
ctx.obj.set_studio_mode_enabled(False)
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print('Studio mode has been disabled.')
|
):
|
||||||
|
"""Toggle studio mode.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
"""
|
||||||
def toggle(ctx: typer.Context):
|
resp = ctx.client.get_studio_mode_enabled()
|
||||||
"""Toggle studio mode."""
|
|
||||||
resp = ctx.obj.get_studio_mode_enabled()
|
|
||||||
if resp.studio_mode_enabled:
|
if resp.studio_mode_enabled:
|
||||||
ctx.obj.set_studio_mode_enabled(False)
|
ctx.client.set_studio_mode_enabled(False)
|
||||||
out_console.print('Studio mode is now disabled.')
|
console.out.print('Studio mode is now disabled.')
|
||||||
else:
|
else:
|
||||||
ctx.obj.set_studio_mode_enabled(True)
|
ctx.client.set_studio_mode_enabled(True)
|
||||||
out_console.print('Studio mode is now enabled.')
|
console.out.print('Studio mode is now enabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context):
|
def status(
|
||||||
"""Get the status of studio mode."""
|
*,
|
||||||
resp = ctx.obj.get_studio_mode_enabled()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the status of studio mode.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
Context containing the OBS WebSocket client instance.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_studio_mode_enabled()
|
||||||
if resp.studio_mode_enabled:
|
if resp.studio_mode_enabled:
|
||||||
out_console.print('Studio mode is enabled.')
|
console.out.print('Studio mode is enabled.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Studio mode is disabled.')
|
console.out.print('Studio mode is disabled.')
|
||||||
|
|||||||
183
obsws_cli/styles.py
Normal file
183
obsws_cli/styles.py
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
"""module containing styles for the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
registry = {}
|
||||||
|
|
||||||
|
|
||||||
|
def register_style(cls):
|
||||||
|
"""Register a style class."""
|
||||||
|
key = cls.__name__.lower()
|
||||||
|
if key in registry:
|
||||||
|
raise ValueError(f'Style {key} is already registered.')
|
||||||
|
registry[key] = cls
|
||||||
|
return cls
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Style:
|
||||||
|
"""Base class for styles."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
border: str
|
||||||
|
column: str
|
||||||
|
highlight: str
|
||||||
|
no_border: bool = False
|
||||||
|
|
||||||
|
def __post_init__(self):
|
||||||
|
"""Post-initialization to set default values and normalize the name."""
|
||||||
|
self.name = self.name.lower()
|
||||||
|
if self.no_border:
|
||||||
|
self.border = None
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Disabled(Style):
|
||||||
|
"""Disabled style."""
|
||||||
|
|
||||||
|
name: str = 'disabled'
|
||||||
|
border: str = 'none'
|
||||||
|
column: str = 'none'
|
||||||
|
highlight: str = 'none'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Red(Style):
|
||||||
|
"""Red style."""
|
||||||
|
|
||||||
|
name: str = 'red'
|
||||||
|
border: str = 'red3'
|
||||||
|
column: str = 'red1'
|
||||||
|
highlight: str = 'red1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Magenta(Style):
|
||||||
|
"""Magenta style."""
|
||||||
|
|
||||||
|
name: str = 'magenta'
|
||||||
|
border: str = 'magenta3'
|
||||||
|
column: str = 'orchid1'
|
||||||
|
highlight: str = 'orchid1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Purple(Style):
|
||||||
|
"""Purple style."""
|
||||||
|
|
||||||
|
name: str = 'purple'
|
||||||
|
border: str = 'medium_purple4'
|
||||||
|
column: str = 'medium_purple'
|
||||||
|
highlight: str = 'medium_purple'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Blue(Style):
|
||||||
|
"""Blue style."""
|
||||||
|
|
||||||
|
name: str = 'blue'
|
||||||
|
border: str = 'cornflower_blue'
|
||||||
|
column: str = 'sky_blue2'
|
||||||
|
highlight: str = 'sky_blue2'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Cyan(Style):
|
||||||
|
"""Cyan style."""
|
||||||
|
|
||||||
|
name: str = 'cyan'
|
||||||
|
border: str = 'dark_cyan'
|
||||||
|
column: str = 'cyan'
|
||||||
|
highlight: str = 'cyan'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Green(Style):
|
||||||
|
"""Green style."""
|
||||||
|
|
||||||
|
name: str = 'green'
|
||||||
|
border: str = 'green4'
|
||||||
|
column: str = 'spring_green3'
|
||||||
|
highlight: str = 'spring_green3'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Yellow(Style):
|
||||||
|
"""Yellow style."""
|
||||||
|
|
||||||
|
name: str = 'yellow'
|
||||||
|
border: str = 'yellow3'
|
||||||
|
column: str = 'wheat1'
|
||||||
|
highlight: str = 'wheat1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Orange(Style):
|
||||||
|
"""Orange style."""
|
||||||
|
|
||||||
|
name: str = 'orange'
|
||||||
|
border: str = 'dark_orange'
|
||||||
|
column: str = 'orange1'
|
||||||
|
highlight: str = 'orange1'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class White(Style):
|
||||||
|
"""White style."""
|
||||||
|
|
||||||
|
name: str = 'white'
|
||||||
|
border: str = 'grey82'
|
||||||
|
column: str = 'grey100'
|
||||||
|
highlight: str = 'grey100'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Grey(Style):
|
||||||
|
"""Grey style."""
|
||||||
|
|
||||||
|
name: str = 'grey'
|
||||||
|
border: str = 'grey50'
|
||||||
|
column: str = 'grey70'
|
||||||
|
highlight: str = 'grey70'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Navy(Style):
|
||||||
|
"""Navy Blue style."""
|
||||||
|
|
||||||
|
name: str = 'navyblue'
|
||||||
|
border: str = 'deep_sky_blue4'
|
||||||
|
column: str = 'light_sky_blue3'
|
||||||
|
highlight: str = 'light_sky_blue3'
|
||||||
|
|
||||||
|
|
||||||
|
@register_style
|
||||||
|
@dataclass
|
||||||
|
class Black(Style):
|
||||||
|
"""Black style."""
|
||||||
|
|
||||||
|
name: str = 'black'
|
||||||
|
border: str = 'grey19'
|
||||||
|
column: str = 'grey11'
|
||||||
|
highlight: str = 'grey11'
|
||||||
|
|
||||||
|
|
||||||
|
def request_style_obj(style_name: str, no_border: bool) -> Style:
|
||||||
|
"""Entry point for style objects. Returns a Style object based on the style name."""
|
||||||
|
if style_name == 'disabled':
|
||||||
|
os.environ['NO_COLOR'] = '1'
|
||||||
|
|
||||||
|
return registry[style_name.lower()](no_border=no_border)
|
||||||
94
obsws_cli/text.py
Normal file
94
obsws_cli/text.py
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
"""module containing commands for manipulating text inputs."""
|
||||||
|
|
||||||
|
from typing import Annotated, Optional
|
||||||
|
|
||||||
|
from cyclopts import App, Parameter
|
||||||
|
|
||||||
|
from . import console, validate
|
||||||
|
from .context import Context
|
||||||
|
from .enum import ExitCode
|
||||||
|
from .error import OBSWSCLIError
|
||||||
|
|
||||||
|
app = App(name='text', help='Commands for controlling text inputs in OBS.')
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['current', 'get'])
|
||||||
|
def current(
|
||||||
|
input_name: str,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the current text for a text input.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input_name : str
|
||||||
|
The name of the text input to retrieve the current text from.
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not validate.input_in_inputs(ctx, input_name):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] not found.', code=ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
resp = ctx.client.get_input_settings(name=input_name)
|
||||||
|
if not resp.input_kind.startswith('text_'):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] is not a text input.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
|
current_text = resp.input_settings.get('text', '')
|
||||||
|
if not current_text:
|
||||||
|
current_text = '(empty)'
|
||||||
|
console.out.print(
|
||||||
|
f'Current text for input {console.highlight(ctx, input_name)}: {current_text}',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(name=['update', 'set'])
|
||||||
|
def update(
|
||||||
|
input_name: str,
|
||||||
|
new_text: Optional[str] = None,
|
||||||
|
/,
|
||||||
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Update the text of a text input.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
input_name : str
|
||||||
|
The name of the text input to update.
|
||||||
|
new_text : Optional[str]
|
||||||
|
The new text to set for the input. If not provided, the text will be cleared
|
||||||
|
(set to an empty string).
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not validate.input_in_inputs(ctx, input_name):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] not found.', code=ExitCode.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
|
resp = ctx.client.get_input_settings(name=input_name)
|
||||||
|
if not resp.input_kind.startswith('text_'):
|
||||||
|
raise OBSWSCLIError(
|
||||||
|
f'Input [yellow]{input_name}[/yellow] is not a text input.',
|
||||||
|
code=ExitCode.ERROR,
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.client.set_input_settings(
|
||||||
|
name=input_name,
|
||||||
|
settings={'text': new_text},
|
||||||
|
overlay=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not new_text:
|
||||||
|
new_text = '(empty)'
|
||||||
|
console.out.print(
|
||||||
|
f'Text for input {console.highlight(ctx, input_name)} updated to: {new_text}',
|
||||||
|
)
|
||||||
@@ -1,6 +1,22 @@
|
|||||||
"""module contains utility functions for the obsws_cli package."""
|
"""module contains utility functions for the obsws_cli package."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
def snakecase_to_titlecase(snake_str):
|
|
||||||
|
def snakecase_to_titlecase(snake_str: str) -> str:
|
||||||
"""Convert a snake_case string to a title case string."""
|
"""Convert a snake_case string to a title case string."""
|
||||||
return snake_str.replace('_', ' ').title()
|
return snake_str.replace('_', ' ').title()
|
||||||
|
|
||||||
|
|
||||||
|
def check_mark(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 ''
|
||||||
|
|
||||||
|
# rich gracefully handles the absence of colour throughout the rest of the application,
|
||||||
|
# but here we must handle it manually.
|
||||||
|
# If NO_COLOR is set, we return plain text symbols.
|
||||||
|
# Otherwise, we return coloured symbols.
|
||||||
|
if os.getenv('NO_COLOR', '') != '':
|
||||||
|
return '✓' if value else '✗'
|
||||||
|
return '✅' if value else '❌'
|
||||||
|
|||||||
@@ -1,48 +1,49 @@
|
|||||||
"""module containing validation functions."""
|
"""module containing validation functions."""
|
||||||
|
|
||||||
import typer
|
from .context import Context
|
||||||
|
|
||||||
# type alias for an option that is skipped when the command is run
|
|
||||||
skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
|
|
||||||
|
|
||||||
|
|
||||||
def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
|
def input_in_inputs(ctx: Context, input_name: str) -> bool:
|
||||||
"""Check if an input is in the input list."""
|
"""Check if an input is in the input list."""
|
||||||
inputs = ctx.obj.get_input_list().inputs
|
inputs = ctx.client.get_input_list().inputs
|
||||||
return any(input_.get('inputName') == input_name for input_ in inputs)
|
return any(input_.get('inputName') == input_name for input_ in inputs)
|
||||||
|
|
||||||
|
|
||||||
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
|
def scene_in_scenes(ctx: Context, scene_name: str) -> bool:
|
||||||
"""Check if a scene exists in the list of scenes."""
|
"""Check if a scene exists in the list of scenes."""
|
||||||
resp = ctx.obj.get_scene_list()
|
resp = ctx.client.get_scene_list()
|
||||||
return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
|
return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
|
||||||
|
|
||||||
|
|
||||||
def studio_mode_enabled(ctx: typer.Context) -> bool:
|
def studio_mode_enabled(ctx: Context) -> bool:
|
||||||
"""Check if studio mode is enabled."""
|
"""Check if studio mode is enabled."""
|
||||||
resp = ctx.obj.get_studio_mode_enabled()
|
resp = ctx.client.get_studio_mode_enabled()
|
||||||
return resp.studio_mode_enabled
|
return resp.studio_mode_enabled
|
||||||
|
|
||||||
|
|
||||||
def scene_collection_in_scene_collections(
|
def scene_collection_in_scene_collections(
|
||||||
ctx: typer.Context, scene_collection_name: str
|
ctx: Context, scene_collection_name: str
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""Check if a scene collection exists."""
|
"""Check if a scene collection exists."""
|
||||||
resp = ctx.obj.get_scene_collection_list()
|
resp = ctx.client.get_scene_collection_list()
|
||||||
return any(
|
return any(
|
||||||
collection == scene_collection_name for collection in resp.scene_collections
|
collection == scene_collection_name for collection in resp.scene_collections
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def item_in_scene_item_list(
|
def item_in_scene_item_list(ctx: Context, scene_name: str, item_name: str) -> bool:
|
||||||
ctx: typer.Context, scene_name: str, item_name: str
|
|
||||||
) -> bool:
|
|
||||||
"""Check if an item exists in a scene."""
|
"""Check if an item exists in a scene."""
|
||||||
resp = ctx.obj.get_scene_item_list(scene_name)
|
resp = ctx.client.get_scene_item_list(scene_name)
|
||||||
return any(item.get('sourceName') == item_name for item in resp.scene_items)
|
return any(item.get('sourceName') == item_name for item in resp.scene_items)
|
||||||
|
|
||||||
|
|
||||||
def profile_exists(ctx: typer.Context, profile_name: str) -> bool:
|
def profile_exists(ctx: Context, profile_name: str) -> bool:
|
||||||
"""Check if a profile exists."""
|
"""Check if a profile exists."""
|
||||||
resp = ctx.obj.get_profile_list()
|
resp = ctx.client.get_profile_list()
|
||||||
return any(profile == profile_name for profile in resp.profiles)
|
return any(profile == profile_name for profile in resp.profiles)
|
||||||
|
|
||||||
|
|
||||||
|
def monitor_exists(ctx: Context, monitor_index: int) -> bool:
|
||||||
|
"""Check if a monitor exists."""
|
||||||
|
resp = ctx.client.get_monitor_list()
|
||||||
|
return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)
|
||||||
|
|||||||
@@ -1,49 +1,84 @@
|
|||||||
"""module containing commands for manipulating virtual camera in OBS."""
|
"""module containing commands for manipulating virtual camera in OBS."""
|
||||||
|
|
||||||
import typer
|
from typing import Annotated
|
||||||
from rich.console import Console
|
|
||||||
|
|
||||||
from .alias import AliasGroup
|
from cyclopts import App, Parameter
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
from . import console
|
||||||
out_console = Console()
|
from .context import Context
|
||||||
err_console = Console(stderr=True)
|
|
||||||
|
app = App(name='virtualcam', help='Commands for controlling the virtual camera in OBS.')
|
||||||
|
|
||||||
|
|
||||||
@app.callback()
|
@app.command(name=['start', 's'])
|
||||||
def main():
|
def start(
|
||||||
"""Control virtual camera in OBS."""
|
*,
|
||||||
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Start the virtual camera.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.start_virtual_cam()
|
||||||
|
console.out.print('Virtual camera started.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('start | s')
|
@app.command(name=['stop', 'p'])
|
||||||
def start(ctx: typer.Context):
|
def stop(
|
||||||
"""Start the virtual camera."""
|
*,
|
||||||
ctx.obj.start_virtual_cam()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print('Virtual camera started.')
|
):
|
||||||
|
"""Stop the virtual camera.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
ctx.client.stop_virtual_cam()
|
||||||
|
console.out.print('Virtual camera stopped.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('stop | p')
|
@app.command(name=['toggle', 'tg'])
|
||||||
def stop(ctx: typer.Context):
|
def toggle(
|
||||||
"""Stop the virtual camera."""
|
*,
|
||||||
ctx.obj.stop_virtual_cam()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
out_console.print('Virtual camera stopped.')
|
):
|
||||||
|
"""Toggle the virtual camera.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
@app.command('toggle | tg')
|
"""
|
||||||
def toggle(ctx: typer.Context):
|
resp = ctx.client.toggle_virtual_cam()
|
||||||
"""Toggle the virtual camera."""
|
|
||||||
resp = ctx.obj.toggle_virtual_cam()
|
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Virtual camera is enabled.')
|
console.out.print('Virtual camera is enabled.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Virtual camera is disabled.')
|
console.out.print('Virtual camera is disabled.')
|
||||||
|
|
||||||
|
|
||||||
@app.command('status | ss')
|
@app.command(name=['status', 'ss'])
|
||||||
def status(ctx: typer.Context):
|
def status(
|
||||||
"""Get the status of the virtual camera."""
|
*,
|
||||||
resp = ctx.obj.get_virtual_cam_status()
|
ctx: Annotated[Context, Parameter(parse=False)],
|
||||||
|
):
|
||||||
|
"""Get the status of the virtual camera.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
ctx : Context
|
||||||
|
The context containing the OBS client and other settings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
resp = ctx.client.get_virtual_cam_status()
|
||||||
if resp.output_active:
|
if resp.output_active:
|
||||||
out_console.print('Virtual camera is enabled.')
|
console.out.print('Virtual camera is enabled.')
|
||||||
else:
|
else:
|
||||||
out_console.print('Virtual camera is disabled.')
|
console.out.print('Virtual camera is disabled.')
|
||||||
|
|||||||
@@ -21,11 +21,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: Implementation :: CPython",
|
"Programming Language :: Python :: Implementation :: CPython",
|
||||||
"Programming Language :: Python :: Implementation :: PyPy",
|
"Programming Language :: Python :: Implementation :: PyPy",
|
||||||
]
|
]
|
||||||
dependencies = [
|
dependencies = ["cyclopts>=3.22.2", "obsws-python>=1.8.0"]
|
||||||
"typer>=0.16.0",
|
|
||||||
"obsws-python>=1.7.2",
|
|
||||||
"pydantic-settings>=2.9.1",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
@@ -34,7 +30,7 @@ Issues = "https://github.com/onyx-and-iris/obsws-cli/issues"
|
|||||||
Source = "https://github.com/onyx-and-iris/obsws-cli"
|
Source = "https://github.com/onyx-and-iris/obsws-cli"
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
obsws-cli = "obsws_cli:app"
|
obsws-cli = "obsws_cli:run"
|
||||||
|
|
||||||
[tool.hatch.version]
|
[tool.hatch.version]
|
||||||
path = "obsws_cli/__about__.py"
|
path = "obsws_cli/__about__.py"
|
||||||
@@ -46,6 +42,9 @@ dependencies = ["click-man>=0.5.1"]
|
|||||||
cli = "obsws-cli {args:}"
|
cli = "obsws-cli {args:}"
|
||||||
man = "python man/generate.py --output=./man"
|
man = "python man/generate.py --output=./man"
|
||||||
|
|
||||||
|
[tool.hatch.envs.lazyimports.scripts]
|
||||||
|
cli = "obsws-cli {args:}"
|
||||||
|
|
||||||
[tool.hatch.envs.hatch-test]
|
[tool.hatch.envs.hatch-test]
|
||||||
randomize = true
|
randomize = true
|
||||||
|
|
||||||
|
|||||||
@@ -71,6 +71,13 @@ def pytest_sessionstart(session):
|
|||||||
},
|
},
|
||||||
sceneItemEnabled=True,
|
sceneItemEnabled=True,
|
||||||
)
|
)
|
||||||
|
session.obsws.create_input(
|
||||||
|
sceneName='pytest_scene',
|
||||||
|
inputName='pytest_text_input',
|
||||||
|
inputKind='text_gdiplus_v3',
|
||||||
|
inputSettings={'text': 'Hello, OBS!'},
|
||||||
|
sceneItemEnabled=True,
|
||||||
|
)
|
||||||
resp = session.obsws.get_scene_item_list('pytest_scene')
|
resp = session.obsws.get_scene_item_list('pytest_scene')
|
||||||
for item in resp.scene_items:
|
for item in resp.scene_items:
|
||||||
if item['sourceName'] == 'pytest_input_2':
|
if item['sourceName'] == 'pytest_input_2':
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ def test_filter_list_invalid_source():
|
|||||||
"""Test the filter list command with an invalid source."""
|
"""Test the filter list command with an invalid source."""
|
||||||
result = runner.invoke(app, ['filter', 'list', 'invalid_source'])
|
result = runner.invoke(app, ['filter', 'list', 'invalid_source'])
|
||||||
assert result.exit_code != 0
|
assert result.exit_code != 0
|
||||||
assert "No source was found by the name of 'invalid_source'" in result.stderr
|
assert 'No source was found by the name of invalid_source' in result.stderr
|
||||||
|
|||||||
@@ -18,29 +18,29 @@ def test_group_show():
|
|||||||
"""Test the group show command."""
|
"""Test the group show command."""
|
||||||
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_group_toggle():
|
def test_group_toggle():
|
||||||
"""Test the group toggle command."""
|
"""Test the group toggle command."""
|
||||||
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
enabled = "Group 'test_group' is now visible." in result.stdout
|
enabled = 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
if enabled:
|
if enabled:
|
||||||
assert "Group 'test_group' is now hidden." in result.stdout
|
assert 'Group test_group is now hidden.' in result.stdout
|
||||||
else:
|
else:
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_group_status():
|
def test_group_status():
|
||||||
"""Test the group status command."""
|
"""Test the group status command."""
|
||||||
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
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', 'Scene', 'test_group'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert "Group 'test_group' is now visible." in result.stdout
|
assert 'Group test_group is now visible.' in result.stdout
|
||||||
|
|||||||
@@ -36,3 +36,10 @@ def test_scene_switch():
|
|||||||
result = runner.invoke(app, ['scene', 'switch', 'pytest_scene'])
|
result = runner.invoke(app, ['scene', 'switch', 'pytest_scene'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'Switched to program scene: pytest_scene' in result.stdout
|
assert 'Switched to program scene: pytest_scene' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_scene_switch_invalid():
|
||||||
|
"""Test the scene switch command with an invalid scene."""
|
||||||
|
result = runner.invoke(app, ['scene', 'switch', 'non_existent_scene'])
|
||||||
|
assert result.exit_code != 0
|
||||||
|
assert 'Scene non_existent_scene not found' in result.stderr
|
||||||
|
|||||||
@@ -29,6 +29,6 @@ def test_sceneitem_transform():
|
|||||||
)
|
)
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert (
|
assert (
|
||||||
"Item 'pytest_input_2' in scene 'pytest_scene' has been transformed"
|
'Item pytest_input_2 in scene pytest_scene has been transformed'
|
||||||
in result.stdout
|
in result.stdout
|
||||||
)
|
)
|
||||||
|
|||||||
18
tests/test_text.py
Normal file
18
tests/test_text.py
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
"""Unit tests for the text command in the OBS WebSocket CLI."""
|
||||||
|
|
||||||
|
from typer.testing import CliRunner
|
||||||
|
|
||||||
|
from obsws_cli.app import app
|
||||||
|
|
||||||
|
runner = CliRunner(mix_stderr=False)
|
||||||
|
|
||||||
|
|
||||||
|
def test_text_update():
|
||||||
|
"""Test the text update command."""
|
||||||
|
result = runner.invoke(app, ['text', 'current', 'pytest_text_input'])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert 'Current text for input pytest_text_input: Hello, OBS!' in result.stdout
|
||||||
|
|
||||||
|
result = runner.invoke(app, ['text', 'update', 'pytest_text_input', 'New Text'])
|
||||||
|
assert result.exit_code == 0
|
||||||
|
assert 'Text for input pytest_text_input updated to: New Text' in result.stdout
|
||||||
@@ -11,7 +11,7 @@ def test_version():
|
|||||||
"""Test the version option."""
|
"""Test the version option."""
|
||||||
result = runner.invoke(app, ['--version'])
|
result = runner.invoke(app, ['--version'])
|
||||||
assert result.exit_code == 0
|
assert result.exit_code == 0
|
||||||
assert 'obsws_cli version:' in result.stdout
|
assert 'obsws-cli version:' in result.stdout
|
||||||
|
|
||||||
|
|
||||||
def test_obs_version():
|
def test_obs_version():
|
||||||
|
|||||||
149
uv.lock
generated
149
uv.lock
generated
@@ -2,15 +2,6 @@ version = 1
|
|||||||
revision = 2
|
revision = 2
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "annotated-types"
|
|
||||||
version = "0.7.0"
|
|
||||||
source = { registry = "https://pypi.org/simple" }
|
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/ee/67/531ea369ba64dcff5ec9c3402f9f51bf748cec26dde048a2f973a4eea7f5/annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89", size = 16081, upload-time = "2024-05-20T21:33:25.928Z" }
|
|
||||||
wheels = [
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/78/b6/6307fbef88d9b5ee7421e68d78a9f162e0da4900bc5f5793f6d3d0e34fb8/annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53", size = 13643, upload-time = "2024-05-20T21:33:24.1Z" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "click"
|
name = "click"
|
||||||
version = "8.1.8"
|
version = "8.1.8"
|
||||||
@@ -58,15 +49,15 @@ name = "obsws-cli"
|
|||||||
source = { editable = "." }
|
source = { editable = "." }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "obsws-python" },
|
{ name = "obsws-python" },
|
||||||
{ name = "pydantic-settings" },
|
{ name = "python-dotenv" },
|
||||||
{ name = "typer" },
|
{ name = "typer" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[package.metadata]
|
[package.metadata]
|
||||||
requires-dist = [
|
requires-dist = [
|
||||||
{ name = "obsws-python", specifier = ">=1.7.2" },
|
{ name = "obsws-python", specifier = ">=1.7.2" },
|
||||||
{ name = "pydantic-settings", specifier = ">=2.9.1" },
|
{ name = "python-dotenv", specifier = ">=1.1.0" },
|
||||||
{ name = "typer", specifier = ">=0.15.2" },
|
{ name = "typer", specifier = ">=0.16.0" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -82,122 +73,6 @@ wheels = [
|
|||||||
{ url = "https://files.pythonhosted.org/packages/7d/68/a5d63428b26221e0f6cb3968d93ffb951825ba0f82b23d356efedfa19fd5/obsws_python-1.7.2-py3-none-any.whl", hash = "sha256:acda31852ad9d7165de915b0603c13f6df527d3f61619970bf5fb562e300bc85", size = 30863, upload-time = "2025-05-14T19:20:24.603Z" },
|
{ url = "https://files.pythonhosted.org/packages/7d/68/a5d63428b26221e0f6cb3968d93ffb951825ba0f82b23d356efedfa19fd5/obsws_python-1.7.2-py3-none-any.whl", hash = "sha256:acda31852ad9d7165de915b0603c13f6df527d3f61619970bf5fb562e300bc85", size = 30863, upload-time = "2025-05-14T19:20:24.603Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pydantic"
|
|
||||||
version = "2.11.5"
|
|
||||||
source = { registry = "https://pypi.org/simple" }
|
|
||||||
dependencies = [
|
|
||||||
{ name = "annotated-types" },
|
|
||||||
{ name = "pydantic-core" },
|
|
||||||
{ name = "typing-extensions" },
|
|
||||||
{ name = "typing-inspection" },
|
|
||||||
]
|
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/f0/86/8ce9040065e8f924d642c58e4a344e33163a07f6b57f836d0d734e0ad3fb/pydantic-2.11.5.tar.gz", hash = "sha256:7f853db3d0ce78ce8bbb148c401c2cdd6431b3473c0cdff2755c7690952a7b7a", size = 787102, upload-time = "2025-05-22T21:18:08.761Z" }
|
|
||||||
wheels = [
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/b5/69/831ed22b38ff9b4b64b66569f0e5b7b97cf3638346eb95a2147fdb49ad5f/pydantic-2.11.5-py3-none-any.whl", hash = "sha256:f9c26ba06f9747749ca1e5c94d6a85cb84254577553c8785576fd38fa64dc0f7", size = 444229, upload-time = "2025-05-22T21:18:06.329Z" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pydantic-core"
|
|
||||||
version = "2.33.2"
|
|
||||||
source = { registry = "https://pypi.org/simple" }
|
|
||||||
dependencies = [
|
|
||||||
{ name = "typing-extensions" },
|
|
||||||
]
|
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/ad/88/5f2260bdfae97aabf98f1778d43f69574390ad787afb646292a638c923d4/pydantic_core-2.33.2.tar.gz", hash = "sha256:7cb8bc3605c29176e1b105350d2e6474142d7c1bd1d9327c4a9bdb46bf827acc", size = 435195, upload-time = "2025-04-23T18:33:52.104Z" }
|
|
||||||
wheels = [
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e5/92/b31726561b5dae176c2d2c2dc43a9c5bfba5d32f96f8b4c0a600dd492447/pydantic_core-2.33.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2b3d326aaef0c0399d9afffeb6367d5e26ddc24d351dbc9c636840ac355dc5d8", size = 2028817, upload-time = "2025-04-23T18:30:43.919Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/a3/44/3f0b95fafdaca04a483c4e685fe437c6891001bf3ce8b2fded82b9ea3aa1/pydantic_core-2.33.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:0e5b2671f05ba48b94cb90ce55d8bdcaaedb8ba00cc5359f6810fc918713983d", size = 1861357, upload-time = "2025-04-23T18:30:46.372Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/30/97/e8f13b55766234caae05372826e8e4b3b96e7b248be3157f53237682e43c/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0069c9acc3f3981b9ff4cdfaf088e98d83440a4c7ea1bc07460af3d4dc22e72d", size = 1898011, upload-time = "2025-04-23T18:30:47.591Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/9b/a3/99c48cf7bafc991cc3ee66fd544c0aae8dc907b752f1dad2d79b1b5a471f/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d53b22f2032c42eaaf025f7c40c2e3b94568ae077a606f006d206a463bc69572", size = 1982730, upload-time = "2025-04-23T18:30:49.328Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/de/8e/a5b882ec4307010a840fb8b58bd9bf65d1840c92eae7534c7441709bf54b/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0405262705a123b7ce9f0b92f123334d67b70fd1f20a9372b907ce1080c7ba02", size = 2136178, upload-time = "2025-04-23T18:30:50.907Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e4/bb/71e35fc3ed05af6834e890edb75968e2802fe98778971ab5cba20a162315/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4b25d91e288e2c4e0662b8038a28c6a07eaac3e196cfc4ff69de4ea3db992a1b", size = 2736462, upload-time = "2025-04-23T18:30:52.083Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/31/0d/c8f7593e6bc7066289bbc366f2235701dcbebcd1ff0ef8e64f6f239fb47d/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6bdfe4b3789761f3bcb4b1ddf33355a71079858958e3a552f16d5af19768fef2", size = 2005652, upload-time = "2025-04-23T18:30:53.389Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/d2/7a/996d8bd75f3eda405e3dd219ff5ff0a283cd8e34add39d8ef9157e722867/pydantic_core-2.33.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:efec8db3266b76ef9607c2c4c419bdb06bf335ae433b80816089ea7585816f6a", size = 2113306, upload-time = "2025-04-23T18:30:54.661Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/ff/84/daf2a6fb2db40ffda6578a7e8c5a6e9c8affb251a05c233ae37098118788/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:031c57d67ca86902726e0fae2214ce6770bbe2f710dc33063187a68744a5ecac", size = 2073720, upload-time = "2025-04-23T18:30:56.11Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/77/fb/2258da019f4825128445ae79456a5499c032b55849dbd5bed78c95ccf163/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:f8de619080e944347f5f20de29a975c2d815d9ddd8be9b9b7268e2e3ef68605a", size = 2244915, upload-time = "2025-04-23T18:30:57.501Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/d8/7a/925ff73756031289468326e355b6fa8316960d0d65f8b5d6b3a3e7866de7/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:73662edf539e72a9440129f231ed3757faab89630d291b784ca99237fb94db2b", size = 2241884, upload-time = "2025-04-23T18:30:58.867Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/0b/b0/249ee6d2646f1cdadcb813805fe76265745c4010cf20a8eba7b0e639d9b2/pydantic_core-2.33.2-cp310-cp310-win32.whl", hash = "sha256:0a39979dcbb70998b0e505fb1556a1d550a0781463ce84ebf915ba293ccb7e22", size = 1910496, upload-time = "2025-04-23T18:31:00.078Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/66/ff/172ba8f12a42d4b552917aa65d1f2328990d3ccfc01d5b7c943ec084299f/pydantic_core-2.33.2-cp310-cp310-win_amd64.whl", hash = "sha256:b0379a2b24882fef529ec3b4987cb5d003b9cda32256024e6fe1586ac45fc640", size = 1955019, upload-time = "2025-04-23T18:31:01.335Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/3f/8d/71db63483d518cbbf290261a1fc2839d17ff89fce7089e08cad07ccfce67/pydantic_core-2.33.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:4c5b0a576fb381edd6d27f0a85915c6daf2f8138dc5c267a57c08a62900758c7", size = 2028584, upload-time = "2025-04-23T18:31:03.106Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/24/2f/3cfa7244ae292dd850989f328722d2aef313f74ffc471184dc509e1e4e5a/pydantic_core-2.33.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e799c050df38a639db758c617ec771fd8fb7a5f8eaaa4b27b101f266b216a246", size = 1855071, upload-time = "2025-04-23T18:31:04.621Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/b3/d3/4ae42d33f5e3f50dd467761304be2fa0a9417fbf09735bc2cce003480f2a/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dc46a01bf8d62f227d5ecee74178ffc448ff4e5197c756331f71efcc66dc980f", size = 1897823, upload-time = "2025-04-23T18:31:06.377Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f4/f3/aa5976e8352b7695ff808599794b1fba2a9ae2ee954a3426855935799488/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a144d4f717285c6d9234a66778059f33a89096dfb9b39117663fd8413d582dcc", size = 1983792, upload-time = "2025-04-23T18:31:07.93Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/d5/7a/cda9b5a23c552037717f2b2a5257e9b2bfe45e687386df9591eff7b46d28/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:73cf6373c21bc80b2e0dc88444f41ae60b2f070ed02095754eb5a01df12256de", size = 2136338, upload-time = "2025-04-23T18:31:09.283Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/2b/9f/b8f9ec8dd1417eb9da784e91e1667d58a2a4a7b7b34cf4af765ef663a7e5/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3dc625f4aa79713512d1976fe9f0bc99f706a9dee21dfd1810b4bbbf228d0e8a", size = 2730998, upload-time = "2025-04-23T18:31:11.7Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/47/bc/cd720e078576bdb8255d5032c5d63ee5c0bf4b7173dd955185a1d658c456/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:881b21b5549499972441da4758d662aeea93f1923f953e9cbaff14b8b9565aef", size = 2003200, upload-time = "2025-04-23T18:31:13.536Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/ca/22/3602b895ee2cd29d11a2b349372446ae9727c32e78a94b3d588a40fdf187/pydantic_core-2.33.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:bdc25f3681f7b78572699569514036afe3c243bc3059d3942624e936ec93450e", size = 2113890, upload-time = "2025-04-23T18:31:15.011Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/ff/e6/e3c5908c03cf00d629eb38393a98fccc38ee0ce8ecce32f69fc7d7b558a7/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:fe5b32187cbc0c862ee201ad66c30cf218e5ed468ec8dc1cf49dec66e160cc4d", size = 2073359, upload-time = "2025-04-23T18:31:16.393Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/12/e7/6a36a07c59ebefc8777d1ffdaf5ae71b06b21952582e4b07eba88a421c79/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:bc7aee6f634a6f4a95676fcb5d6559a2c2a390330098dba5e5a5f28a2e4ada30", size = 2245883, upload-time = "2025-04-23T18:31:17.892Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/16/3f/59b3187aaa6cc0c1e6616e8045b284de2b6a87b027cce2ffcea073adf1d2/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:235f45e5dbcccf6bd99f9f472858849f73d11120d76ea8707115415f8e5ebebf", size = 2241074, upload-time = "2025-04-23T18:31:19.205Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e0/ed/55532bb88f674d5d8f67ab121a2a13c385df382de2a1677f30ad385f7438/pydantic_core-2.33.2-cp311-cp311-win32.whl", hash = "sha256:6368900c2d3ef09b69cb0b913f9f8263b03786e5b2a387706c5afb66800efd51", size = 1910538, upload-time = "2025-04-23T18:31:20.541Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/fe/1b/25b7cccd4519c0b23c2dd636ad39d381abf113085ce4f7bec2b0dc755eb1/pydantic_core-2.33.2-cp311-cp311-win_amd64.whl", hash = "sha256:1e063337ef9e9820c77acc768546325ebe04ee38b08703244c1309cccc4f1bab", size = 1952909, upload-time = "2025-04-23T18:31:22.371Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/49/a9/d809358e49126438055884c4366a1f6227f0f84f635a9014e2deb9b9de54/pydantic_core-2.33.2-cp311-cp311-win_arm64.whl", hash = "sha256:6b99022f1d19bc32a4c2a0d544fc9a76e3be90f0b3f4af413f87d38749300e65", size = 1897786, upload-time = "2025-04-23T18:31:24.161Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/18/8a/2b41c97f554ec8c71f2a8a5f85cb56a8b0956addfe8b0efb5b3d77e8bdc3/pydantic_core-2.33.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:a7ec89dc587667f22b6a0b6579c249fca9026ce7c333fc142ba42411fa243cdc", size = 2009000, upload-time = "2025-04-23T18:31:25.863Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/a1/02/6224312aacb3c8ecbaa959897af57181fb6cf3a3d7917fd44d0f2917e6f2/pydantic_core-2.33.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:3c6db6e52c6d70aa0d00d45cdb9b40f0433b96380071ea80b09277dba021ddf7", size = 1847996, upload-time = "2025-04-23T18:31:27.341Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/d6/46/6dcdf084a523dbe0a0be59d054734b86a981726f221f4562aed313dbcb49/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e61206137cbc65e6d5256e1166f88331d3b6238e082d9f74613b9b765fb9025", size = 1880957, upload-time = "2025-04-23T18:31:28.956Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/ec/6b/1ec2c03837ac00886ba8160ce041ce4e325b41d06a034adbef11339ae422/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:eb8c529b2819c37140eb51b914153063d27ed88e3bdc31b71198a198e921e011", size = 1964199, upload-time = "2025-04-23T18:31:31.025Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/2d/1d/6bf34d6adb9debd9136bd197ca72642203ce9aaaa85cfcbfcf20f9696e83/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c52b02ad8b4e2cf14ca7b3d918f3eb0ee91e63b3167c32591e57c4317e134f8f", size = 2120296, upload-time = "2025-04-23T18:31:32.514Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e0/94/2bd0aaf5a591e974b32a9f7123f16637776c304471a0ab33cf263cf5591a/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:96081f1605125ba0855dfda83f6f3df5ec90c61195421ba72223de35ccfb2f88", size = 2676109, upload-time = "2025-04-23T18:31:33.958Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f9/41/4b043778cf9c4285d59742281a769eac371b9e47e35f98ad321349cc5d61/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f57a69461af2a5fa6e6bbd7a5f60d3b7e6cebb687f55106933188e79ad155c1", size = 2002028, upload-time = "2025-04-23T18:31:39.095Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/cb/d5/7bb781bf2748ce3d03af04d5c969fa1308880e1dca35a9bd94e1a96a922e/pydantic_core-2.33.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:572c7e6c8bb4774d2ac88929e3d1f12bc45714ae5ee6d9a788a9fb35e60bb04b", size = 2100044, upload-time = "2025-04-23T18:31:41.034Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/fe/36/def5e53e1eb0ad896785702a5bbfd25eed546cdcf4087ad285021a90ed53/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:db4b41f9bd95fbe5acd76d89920336ba96f03e149097365afe1cb092fceb89a1", size = 2058881, upload-time = "2025-04-23T18:31:42.757Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/01/6c/57f8d70b2ee57fc3dc8b9610315949837fa8c11d86927b9bb044f8705419/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:fa854f5cf7e33842a892e5c73f45327760bc7bc516339fda888c75ae60edaeb6", size = 2227034, upload-time = "2025-04-23T18:31:44.304Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/27/b9/9c17f0396a82b3d5cbea4c24d742083422639e7bb1d5bf600e12cb176a13/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:5f483cfb75ff703095c59e365360cb73e00185e01aaea067cd19acffd2ab20ea", size = 2234187, upload-time = "2025-04-23T18:31:45.891Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/b0/6a/adf5734ffd52bf86d865093ad70b2ce543415e0e356f6cacabbc0d9ad910/pydantic_core-2.33.2-cp312-cp312-win32.whl", hash = "sha256:9cb1da0f5a471435a7bc7e439b8a728e8b61e59784b2af70d7c169f8dd8ae290", size = 1892628, upload-time = "2025-04-23T18:31:47.819Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/43/e4/5479fecb3606c1368d496a825d8411e126133c41224c1e7238be58b87d7e/pydantic_core-2.33.2-cp312-cp312-win_amd64.whl", hash = "sha256:f941635f2a3d96b2973e867144fde513665c87f13fe0e193c158ac51bfaaa7b2", size = 1955866, upload-time = "2025-04-23T18:31:49.635Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/0d/24/8b11e8b3e2be9dd82df4b11408a67c61bb4dc4f8e11b5b0fc888b38118b5/pydantic_core-2.33.2-cp312-cp312-win_arm64.whl", hash = "sha256:cca3868ddfaccfbc4bfb1d608e2ccaaebe0ae628e1416aeb9c4d88c001bb45ab", size = 1888894, upload-time = "2025-04-23T18:31:51.609Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/46/8c/99040727b41f56616573a28771b1bfa08a3d3fe74d3d513f01251f79f172/pydantic_core-2.33.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:1082dd3e2d7109ad8b7da48e1d4710c8d06c253cbc4a27c1cff4fbcaa97a9e3f", size = 2015688, upload-time = "2025-04-23T18:31:53.175Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/3a/cc/5999d1eb705a6cefc31f0b4a90e9f7fc400539b1a1030529700cc1b51838/pydantic_core-2.33.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f517ca031dfc037a9c07e748cefd8d96235088b83b4f4ba8939105d20fa1dcd6", size = 1844808, upload-time = "2025-04-23T18:31:54.79Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/6f/5e/a0a7b8885c98889a18b6e376f344da1ef323d270b44edf8174d6bce4d622/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0a9f2c9dd19656823cb8250b0724ee9c60a82f3cdf68a080979d13092a3b0fef", size = 1885580, upload-time = "2025-04-23T18:31:57.393Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/3b/2a/953581f343c7d11a304581156618c3f592435523dd9d79865903272c256a/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:2b0a451c263b01acebe51895bfb0e1cc842a5c666efe06cdf13846c7418caa9a", size = 1973859, upload-time = "2025-04-23T18:31:59.065Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e6/55/f1a813904771c03a3f97f676c62cca0c0a4138654107c1b61f19c644868b/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ea40a64d23faa25e62a70ad163571c0b342b8bf66d5fa612ac0dec4f069d916", size = 2120810, upload-time = "2025-04-23T18:32:00.78Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/aa/c3/053389835a996e18853ba107a63caae0b9deb4a276c6b472931ea9ae6e48/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0fb2d542b4d66f9470e8065c5469ec676978d625a8b7a363f07d9a501a9cb36a", size = 2676498, upload-time = "2025-04-23T18:32:02.418Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/eb/3c/f4abd740877a35abade05e437245b192f9d0ffb48bbbbd708df33d3cda37/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdac5d6ffa1b5a83bca06ffe7583f5576555e6c8b3a91fbd25ea7780f825f7d", size = 2000611, upload-time = "2025-04-23T18:32:04.152Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/59/a7/63ef2fed1837d1121a894d0ce88439fe3e3b3e48c7543b2a4479eb99c2bd/pydantic_core-2.33.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:04a1a413977ab517154eebb2d326da71638271477d6ad87a769102f7c2488c56", size = 2107924, upload-time = "2025-04-23T18:32:06.129Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/04/8f/2551964ef045669801675f1cfc3b0d74147f4901c3ffa42be2ddb1f0efc4/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:c8e7af2f4e0194c22b5b37205bfb293d166a7344a5b0d0eaccebc376546d77d5", size = 2063196, upload-time = "2025-04-23T18:32:08.178Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/26/bd/d9602777e77fc6dbb0c7db9ad356e9a985825547dce5ad1d30ee04903918/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:5c92edd15cd58b3c2d34873597a1e20f13094f59cf88068adb18947df5455b4e", size = 2236389, upload-time = "2025-04-23T18:32:10.242Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/42/db/0e950daa7e2230423ab342ae918a794964b053bec24ba8af013fc7c94846/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:65132b7b4a1c0beded5e057324b7e16e10910c106d43675d9bd87d4f38dde162", size = 2239223, upload-time = "2025-04-23T18:32:12.382Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/58/4d/4f937099c545a8a17eb52cb67fe0447fd9a373b348ccfa9a87f141eeb00f/pydantic_core-2.33.2-cp313-cp313-win32.whl", hash = "sha256:52fb90784e0a242bb96ec53f42196a17278855b0f31ac7c3cc6f5c1ec4811849", size = 1900473, upload-time = "2025-04-23T18:32:14.034Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/a0/75/4a0a9bac998d78d889def5e4ef2b065acba8cae8c93696906c3a91f310ca/pydantic_core-2.33.2-cp313-cp313-win_amd64.whl", hash = "sha256:c083a3bdd5a93dfe480f1125926afcdbf2917ae714bdb80b36d34318b2bec5d9", size = 1955269, upload-time = "2025-04-23T18:32:15.783Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f9/86/1beda0576969592f1497b4ce8e7bc8cbdf614c352426271b1b10d5f0aa64/pydantic_core-2.33.2-cp313-cp313-win_arm64.whl", hash = "sha256:e80b087132752f6b3d714f041ccf74403799d3b23a72722ea2e6ba2e892555b9", size = 1893921, upload-time = "2025-04-23T18:32:18.473Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/a4/7d/e09391c2eebeab681df2b74bfe6c43422fffede8dc74187b2b0bf6fd7571/pydantic_core-2.33.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:61c18fba8e5e9db3ab908620af374db0ac1baa69f0f32df4f61ae23f15e586ac", size = 1806162, upload-time = "2025-04-23T18:32:20.188Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f1/3d/847b6b1fed9f8ed3bb95a9ad04fbd0b212e832d4f0f50ff4d9ee5a9f15cf/pydantic_core-2.33.2-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95237e53bb015f67b63c91af7518a62a8660376a6a0db19b89acc77a4d6199f5", size = 1981560, upload-time = "2025-04-23T18:32:22.354Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/6f/9a/e73262f6c6656262b5fdd723ad90f518f579b7bc8622e43a942eec53c938/pydantic_core-2.33.2-cp313-cp313t-win_amd64.whl", hash = "sha256:c2fc0a768ef76c15ab9238afa6da7f69895bb5d1ee83aeea2e3509af4472d0b9", size = 1935777, upload-time = "2025-04-23T18:32:25.088Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/30/68/373d55e58b7e83ce371691f6eaa7175e3a24b956c44628eb25d7da007917/pydantic_core-2.33.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:5c4aa4e82353f65e548c476b37e64189783aa5384903bfea4f41580f255fddfa", size = 2023982, upload-time = "2025-04-23T18:32:53.14Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/a4/16/145f54ac08c96a63d8ed6442f9dec17b2773d19920b627b18d4f10a061ea/pydantic_core-2.33.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:d946c8bf0d5c24bf4fe333af284c59a19358aa3ec18cb3dc4370080da1e8ad29", size = 1858412, upload-time = "2025-04-23T18:32:55.52Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/41/b1/c6dc6c3e2de4516c0bb2c46f6a373b91b5660312342a0cf5826e38ad82fa/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:87b31b6846e361ef83fedb187bb5b4372d0da3f7e28d85415efa92d6125d6e6d", size = 1892749, upload-time = "2025-04-23T18:32:57.546Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/12/73/8cd57e20afba760b21b742106f9dbdfa6697f1570b189c7457a1af4cd8a0/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aa9d91b338f2df0508606f7009fde642391425189bba6d8c653afd80fd6bb64e", size = 2067527, upload-time = "2025-04-23T18:32:59.771Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/e3/d5/0bb5d988cc019b3cba4a78f2d4b3854427fc47ee8ec8e9eaabf787da239c/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2058a32994f1fde4ca0480ab9d1e75a0e8c87c22b53a3ae66554f9af78f2fe8c", size = 2108225, upload-time = "2025-04-23T18:33:04.51Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f1/c5/00c02d1571913d496aabf146106ad8239dc132485ee22efe08085084ff7c/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:0e03262ab796d986f978f79c943fc5f620381be7287148b8010b4097f79a39ec", size = 2069490, upload-time = "2025-04-23T18:33:06.391Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/22/a8/dccc38768274d3ed3a59b5d06f59ccb845778687652daa71df0cab4040d7/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:1a8695a8d00c73e50bff9dfda4d540b7dee29ff9b8053e38380426a85ef10052", size = 2237525, upload-time = "2025-04-23T18:33:08.44Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/d4/e7/4f98c0b125dda7cf7ccd14ba936218397b44f50a56dd8c16a3091df116c3/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:fa754d1850735a0b0e03bcffd9d4b4343eb417e47196e4485d9cca326073a42c", size = 2238446, upload-time = "2025-04-23T18:33:10.313Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/ce/91/2ec36480fdb0b783cd9ef6795753c1dea13882f2e68e73bce76ae8c21e6a/pydantic_core-2.33.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:a11c8d26a50bfab49002947d3d237abe4d9e4b5bdc8846a63537b6488e197808", size = 2066678, upload-time = "2025-04-23T18:33:12.224Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/7b/27/d4ae6487d73948d6f20dddcd94be4ea43e74349b56eba82e9bdee2d7494c/pydantic_core-2.33.2-pp311-pypy311_pp73-macosx_10_12_x86_64.whl", hash = "sha256:dd14041875d09cc0f9308e37a6f8b65f5585cf2598a53aa0123df8b129d481f8", size = 2025200, upload-time = "2025-04-23T18:33:14.199Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/f1/b8/b3cb95375f05d33801024079b9392a5ab45267a63400bf1866e7ce0f0de4/pydantic_core-2.33.2-pp311-pypy311_pp73-macosx_11_0_arm64.whl", hash = "sha256:d87c561733f66531dced0da6e864f44ebf89a8fba55f31407b00c2f7f9449593", size = 1859123, upload-time = "2025-04-23T18:33:16.555Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/05/bc/0d0b5adeda59a261cd30a1235a445bf55c7e46ae44aea28f7bd6ed46e091/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2f82865531efd18d6e07a04a17331af02cb7a651583c418df8266f17a63c6612", size = 1892852, upload-time = "2025-04-23T18:33:18.513Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/3e/11/d37bdebbda2e449cb3f519f6ce950927b56d62f0b84fd9cb9e372a26a3d5/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2bfb5112df54209d820d7bf9317c7a6c9025ea52e49f46b6a2060104bba37de7", size = 2067484, upload-time = "2025-04-23T18:33:20.475Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/8c/55/1f95f0a05ce72ecb02a8a8a1c3be0579bbc29b1d5ab68f1378b7bebc5057/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:64632ff9d614e5eecfb495796ad51b0ed98c453e447a76bcbeeb69615079fc7e", size = 2108896, upload-time = "2025-04-23T18:33:22.501Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/53/89/2b2de6c81fa131f423246a9109d7b2a375e83968ad0800d6e57d0574629b/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:f889f7a40498cc077332c7ab6b4608d296d852182211787d4f3ee377aaae66e8", size = 2069475, upload-time = "2025-04-23T18:33:24.528Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/b8/e9/1f7efbe20d0b2b10f6718944b5d8ece9152390904f29a78e68d4e7961159/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:de4b83bb311557e439b9e186f733f6c645b9417c84e2eb8203f3f820a4b988bf", size = 2239013, upload-time = "2025-04-23T18:33:26.621Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/3c/b2/5309c905a93811524a49b4e031e9851a6b00ff0fb668794472ea7746b448/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:82f68293f055f51b51ea42fafc74b6aad03e70e191799430b90c13d643059ebb", size = 2238715, upload-time = "2025-04-23T18:33:28.656Z" },
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/32/56/8a7ca5d2cd2cda1d245d34b1c9a942920a718082ae8e54e5f3e5a58b7add/pydantic_core-2.33.2-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:329467cecfb529c925cf2bbd4d60d2c509bc2fb52a20c1045bf09bb70971a9c1", size = 2066757, upload-time = "2025-04-23T18:33:30.645Z" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pydantic-settings"
|
|
||||||
version = "2.9.1"
|
|
||||||
source = { registry = "https://pypi.org/simple" }
|
|
||||||
dependencies = [
|
|
||||||
{ name = "pydantic" },
|
|
||||||
{ name = "python-dotenv" },
|
|
||||||
{ name = "typing-inspection" },
|
|
||||||
]
|
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/67/1d/42628a2c33e93f8e9acbde0d5d735fa0850f3e6a2f8cb1eb6c40b9a732ac/pydantic_settings-2.9.1.tar.gz", hash = "sha256:c509bf79d27563add44e8446233359004ed85066cd096d8b510f715e6ef5d268", size = 163234, upload-time = "2025-04-18T16:44:48.265Z" }
|
|
||||||
wheels = [
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/b6/5f/d6d641b490fd3ec2c4c13b4244d68deea3a1b970a97be64f34fb5504ff72/pydantic_settings-2.9.1-py3-none-any.whl", hash = "sha256:59b4f431b1defb26fe620c71a7d3968a710d719f5f4cdbbdb7926edeb770f6ef", size = 44356, upload-time = "2025-04-18T16:44:46.617Z" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pygments"
|
name = "pygments"
|
||||||
version = "2.19.1"
|
version = "2.19.1"
|
||||||
@@ -280,7 +155,7 @@ wheels = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "typer"
|
name = "typer"
|
||||||
version = "0.15.4"
|
version = "0.16.0"
|
||||||
source = { registry = "https://pypi.org/simple" }
|
source = { registry = "https://pypi.org/simple" }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "click" },
|
{ name = "click" },
|
||||||
@@ -288,9 +163,9 @@ dependencies = [
|
|||||||
{ name = "shellingham" },
|
{ name = "shellingham" },
|
||||||
{ name = "typing-extensions" },
|
{ name = "typing-extensions" },
|
||||||
]
|
]
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/6c/89/c527e6c848739be8ceb5c44eb8208c52ea3515c6cf6406aa61932887bf58/typer-0.15.4.tar.gz", hash = "sha256:89507b104f9b6a0730354f27c39fae5b63ccd0c95b1ce1f1a6ba0cfd329997c3", size = 101559, upload-time = "2025-05-14T16:34:57.704Z" }
|
sdist = { url = "https://files.pythonhosted.org/packages/c5/8c/7d682431efca5fd290017663ea4588bf6f2c6aad085c7f108c5dbc316e70/typer-0.16.0.tar.gz", hash = "sha256:af377ffaee1dbe37ae9440cb4e8f11686ea5ce4e9bae01b84ae7c63b87f1dd3b", size = 102625, upload-time = "2025-05-26T14:30:31.824Z" }
|
||||||
wheels = [
|
wheels = [
|
||||||
{ url = "https://files.pythonhosted.org/packages/c9/62/d4ba7afe2096d5659ec3db8b15d8665bdcb92a3c6ff0b95e99895b335a9c/typer-0.15.4-py3-none-any.whl", hash = "sha256:eb0651654dcdea706780c466cf06d8f174405a659ffff8f163cfbfee98c0e173", size = 45258, upload-time = "2025-05-14T16:34:55.583Z" },
|
{ url = "https://files.pythonhosted.org/packages/76/42/3efaf858001d2c2913de7f354563e3a3a2f0decae3efe98427125a8f441e/typer-0.16.0-py3-none-any.whl", hash = "sha256:1f79bed11d4d02d4310e3c1b7ba594183bcedb0ac73b27a9e5f28f6fb5b98855", size = 46317, upload-time = "2025-05-26T14:30:30.523Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -302,18 +177,6 @@ wheels = [
|
|||||||
{ url = "https://files.pythonhosted.org/packages/8b/54/b1ae86c0973cc6f0210b53d508ca3641fb6d0c56823f288d108bc7ab3cc8/typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c", size = 45806, upload-time = "2025-04-10T14:19:03.967Z" },
|
{ url = "https://files.pythonhosted.org/packages/8b/54/b1ae86c0973cc6f0210b53d508ca3641fb6d0c56823f288d108bc7ab3cc8/typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c", size = 45806, upload-time = "2025-04-10T14:19:03.967Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "typing-inspection"
|
|
||||||
version = "0.4.1"
|
|
||||||
source = { registry = "https://pypi.org/simple" }
|
|
||||||
dependencies = [
|
|
||||||
{ name = "typing-extensions" },
|
|
||||||
]
|
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/f8/b1/0c11f5058406b3af7609f121aaa6b609744687f1d158b3c3a5bf4cc94238/typing_inspection-0.4.1.tar.gz", hash = "sha256:6ae134cc0203c33377d43188d4064e9b357dba58cff3185f22924610e70a9d28", size = 75726, upload-time = "2025-05-21T18:55:23.885Z" }
|
|
||||||
wheels = [
|
|
||||||
{ url = "https://files.pythonhosted.org/packages/17/69/cd203477f944c353c31bade965f880aa1061fd6bf05ded0726ca845b6ff7/typing_inspection-0.4.1-py3-none-any.whl", hash = "sha256:389055682238f53b04f7badcb49b989835495a96700ced5dab2d8feae4b26f51", size = 14552, upload-time = "2025-05-21T18:55:22.152Z" },
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "websocket-client"
|
name = "websocket-client"
|
||||||
version = "1.8.0"
|
version = "1.8.0"
|
||||||
|
|||||||
Reference in New Issue
Block a user