Metadata-Version: 2.1
Name: obws-commands
Version: 0.0.3
Summary: An event-based command line interface for OBS Websocket
Author-email: Dennis Sitelew <yowidin@gmail.com>
Project-URL: homepage, https://github.com/yowidin/obws-commands
Project-URL: bugtrack, https://github.com/yowidin/obws-commands/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# OBS Web Socket Commands
A list of commands that can be sent to OBS via the Web Socket plugin. This project contains only a subset of all
available commands, and is mostly focused on the commands that are useful for recording. The main point of the 
implemented commands is to be chainable, i.e.: the control only returns once a command is executed and the OBS 
reports the new state. Or in more practical terms: the `switch-profile-and-scene-collection` command is the only
reason for this package to exist.

# Usage

You can execute a single command from the command line:
```shell
obws-command pause-record
```
This assumes the `config.toml` file is in the current directory.

---

Or you can call a command from inside a script:
```python
from obwsc.commands.pause_record import PauseRecord

config = {'host': 'localhost', 'port': 4455, 'password': 'secret'}
PauseRecord(config).execute()
```
