onyx_online/obsws-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-python.git synced 2024-11-22 12:50:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

add support for python 3.10.

Browse Source 
update python ver in readme

all tests run and passed for version 3.10

setup.py removed from gitignore.
This commit is contained in:
onyx-and-iris 2022-08-31 20:13:23 +01:00
parent 35b7c16b6b
commit 7c6ebd1dae
4 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -20,7 +20,6 @@ wheels/
*.egg-info/ *.egg-info/
.installed.cfg .installed.cfg
*.egg *.egg
setup.py
MANIFEST MANIFEST
# Unit test / coverage reports # Unit test / coverage reports

14
README.md
View File

@ -12,7 +12,7 @@ Not all endpoints in the official documentation are implemented.
- [OBS Studio](https://obsproject.com/) - [OBS Studio](https://obsproject.com/)
- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0) - [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
- Python 3.11 or greater - Python 3.10 or greater
### How to install using pip ### How to install using pip
@ -44,7 +44,7 @@ Import and start using, keyword arguments are as follows:
Example `__main__.py`: Example `__main__.py`:
```python ```python
from obsstudio_sdk import reqs as obs import obsstudio_sdk as obs
# pass conn info if not in config.toml # pass conn info if not in config.toml
cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass') cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass')
@ -60,15 +60,14 @@ Method names for requests match the API calls but snake cased.
example: example:
```python ```python
from obsstudio_sdk import reqs as obs # load conn info from config.toml
cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass') cl = obs.ReqClient()
# GetVersion # GetVersion
resp = cl.get_version() resp = cl.get_version()
# SetCurrentProgramScene # SetCurrentProgramScene
cl.set_current_program_scene() cl.set_current_program_scene("BRB")
``` ```
For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests) For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
@ -80,7 +79,8 @@ When registering a function callback use the name of the expected API event in s
example: example:
```python ```python
cl = EventClient() # load conn info from config.toml
cl = obs.EventClient()
def scene_created(data): def scene_created(data):
... ...

6
obsstudio_sdk/baseclient.py
View File

@ -4,7 +4,11 @@ import json
from pathlib import Path from pathlib import Path
from random import randint from random import randint
import tomllib try:
import tomllib
except ModuleNotFoundError:
import tomli as tomllib
import websocket import websocket

6
setup.py
View File

@ -5,7 +5,7 @@ from setuptools import find_packages, setup
HERE = pathlib.Path(__file__).parent HERE = pathlib.Path(__file__).parent
VERSION = "1.0.2" VERSION = "1.0.3"
PACKAGE_NAME = "obsstudio_sdk" PACKAGE_NAME = "obsstudio_sdk"
AUTHOR = "Adem Atikturk" AUTHOR = "Adem Atikturk"
AUTHOR_EMAIL = "aatikturk@gmail.com" AUTHOR_EMAIL = "aatikturk@gmail.com"
@ -18,7 +18,7 @@ LONG_DESCRIPTION = (HERE / "README.md").read_text()
LONG_DESC_TYPE = "text/markdown" LONG_DESC_TYPE = "text/markdown"
# Dependencies for the package # Dependencies for the package
INSTALL_REQUIRES = ["websocket-client"] INSTALL_REQUIRES = ["websocket-client", "tomli >= 1.1.0;python_version < '3.11'"]
# Development dependencies # Development dependencies
EXTRAS_REQUIRE = { EXTRAS_REQUIRE = {
@ -31,7 +31,7 @@ EXTRAS_REQUIRE = {
} }
# Python version requirement # Python version requirement
PYTHON_REQUIRES = ">=3.11" PYTHON_REQUIRES = ">=3.10"
setup( setup(
name=PACKAGE_NAME, name=PACKAGE_NAME,