10 Commits

Author SHA1 Message Date
70207c98a0 fix replaybuffer docstring
patch bump
2026-03-28 22:22:07 +00:00
65b4142692 remove fail-on-missing, it's breaking the publish workflow. 2026-03-28 22:09:48 +00:00
9e4071aace scope hatch-dotenv to hatch-test env 2026-03-28 21:55:05 +00:00
ba61f7d9a1 bump deps
patch bump
2026-03-28 21:43:54 +00:00
6a02a4fc86 add obsws-python as local path dep
regen gitignore
2026-03-27 14:12:27 +00:00
0c5e1085cc add pre-commit config 2026-03-21 14:28:05 +00:00
22cf1c817f closes #6 2026-02-26 20:29:11 +00:00
da69702a18 temporary fix for hatch build, see https://github.com/pypa/hatch/issues/2193 2026-02-26 14:44:47 +00:00
9b0d20effd upd hatch badge 2026-02-22 11:37:03 +00:00
998e72f43e upd set_logging for improved readability 2026-02-09 10:32:13 +00:00
7 changed files with 81 additions and 33 deletions

68
.gitignore vendored
View File

@@ -1,9 +1,9 @@
# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
# Generated by ignr: github.com/onyx-and-iris/ignr
### Python ###
## Python ##
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*.py[codz]
*$py.class
# C extensions
@@ -49,7 +49,7 @@ htmlcov/
nosetests.xml
coverage.xml
*.cover
*.py,cover
*.py.cover
.hypothesis/
.pytest_cache/
cover/
@@ -97,20 +97,35 @@ ipython_config.py
# install all needed dependencies.
#Pipfile.lock
# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
#poetry.toml
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
#pdm.toml
.pdm-python
.pdm-build/
# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
#pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
@@ -124,13 +139,13 @@ celerybeat.pid
# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
.hatch
.test.env
# Spyder project settings
@@ -164,17 +179,38 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml
# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/
# ruff
# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer,
# you could uncomment the following to ignore the entire vscode folder
# .vscode/
# Ruff stuff:
.ruff_cache/
# LSP config files
pyrightconfig.json
# PyPI configuration file
.pypirc
# End of gignore: github.com/onyx-and-iris/gignore
# Cursor
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
# refer to https://docs.cursor.com/context/ignore-files
.cursorignore
.cursorindexingignore
# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/
# End of ignr
man/*.1
test-*.py

7
.pre-commit-config.yaml Normal file
View File

@@ -0,0 +1,7 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace

View File

@@ -1,6 +1,6 @@
# obsws-cli
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![Hatch project](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pypa/hatch/master/docs/assets/badge/v0.json)](https://github.com/pypa/hatch)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -50,7 +50,7 @@ The CLI should now be discoverable as `obsws-cli`
- --timeout/-T: Websocket timeout
- --version/-v: Print the obsws-cli version
- --loglevel/-l: Set the application's logging level
- One of *CRITICAL, FATAL, ERROR, WARNING, INFO, DEBUG*
- One of *NOTSET, DEBUG, INFO, WARN, WARNING, ERROR, CRITICAL, FATAL*
Pass `--host`, `--port` and `--password` as flags on the root command, for example:

View File

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

View File

@@ -30,13 +30,19 @@ def version_callback(value: bool):
def setup_logging(loglevel: str):
"""Set up logging for the application."""
numeric_loglevel = logging.getLevelNamesMapping().get(loglevel.upper())
if numeric_loglevel is None:
raise typer.BadParameter(
f'Invalid log level: {loglevel}. Valid options are: {", ".join(logging.getLevelNamesMapping().keys())}'
level_map = logging.getLevelNamesMapping()
try:
level_int = level_map[loglevel.upper()]
except KeyError:
possible_levels = ', '.join(
sorted(level_map.keys(), key=lambda k: level_map[k])
)
raise typer.BadParameter(
f'Invalid log level: {loglevel}. Valid options are: {possible_levels}'
) from None
logging.basicConfig(
level=numeric_loglevel,
level=level_int,
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
)

View File

@@ -9,7 +9,7 @@ app = typer.Typer()
@app.callback()
def main():
"""Control profiles in OBS."""
"""Control the replay buffer in OBS."""
@app.command('start')

View File

@@ -21,7 +21,7 @@ classifiers = [
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = ["typer>=0.21.1", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
dependencies = ["typer>=0.24.1", "obsws-python>=1.8.0", "python-dotenv>=1.2.2"]
[project.urls]
@@ -35,22 +35,21 @@ obsws-cli = "obsws_cli:app"
[tool.hatch.version]
path = "obsws_cli/__about__.py"
[tool.hatch.env]
requires = ["hatch-dotenv"]
[tool.hatch.envs.default]
workspace.members = [{ path = "../obsws-python" }]
dependencies = ["click-man>=0.5.1"]
[tool.hatch.envs.default.scripts]
cli = "obsws-cli {args:}"
man = "python man/generate.py --output=./man"
[tool.hatch.envs.hatch-test]
randomize = true
[tool.hatch.env]
requires = ["hatch-dotenv"]
[tool.hatch.env.collectors.dotenv.hatch-test]
env-files = [".env", ".test.env"]
fail-on-missing = true
[tool.hatch.envs.hatch-test]
randomize = true
[tool.hatch.envs.types]
extra-dependencies = ["mypy>=1.0.0"]