{ "info": { "author": "Guillaume \"Elektordi\" Genty", "author_email": "elektordi@elektordi.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries" ], "description": "# obs-websocket-py\nPython library to communicate with an [obs-websocket](https://github.com/Palakis/obs-websocket) server.\n\n_Licensed under the MIT License_\n\n## Project pages\n\nGitHub project: https://github.com/Elektordi/obs-websocket-py\n\nPyPI package: https://pypi.python.org/pypi/obs-websocket-py\n\n## Installation\n\nJust run `pip install obs-websocket-py` in your Python venv or directly on your system.\n\nFor manual install, git clone the github repo and copy the directory **obswebsocket** in your python project root.\n\n**Requires**: websocket-client (from pip)\n\n## Usage\n\nSee python scripts in the [samples](https://github.com/Elektordi/obs-websocket-py/tree/master/samples) directory.\n\nOr take a look at the documentation below:\n\n_Output of `pydoc obswebsocket.core.obsws`:_\n\n```\nHelp on class obsws in obswebsocket.core:\n\nobswebsocket.core.obsws = class obsws\n | Core class for using obs-websocket-py\n | \n | Simple usage:\n | >>> import obswebsocket, obswebsocket.requests\n | >>> client = obswebsocket.obsws(\"localhost\", 4444, \"secret\")\n | >>> client.connect()\n | >>> client.call(obswebsocket.requests.GetVersion()).getObsWebsocketVersion()\n | u'4.1.0'\n | >>> client.disconnect()\n | \n | For advanced usage, including events callback, see the 'samples' directory.\n | \n | Methods defined here:\n | \n | __init__(self, host=None, port=4444, password='')\n | Construct a new obsws wrapper\n | \n | :param host: Hostname to connect to\n | :param port: TCP Port to connect to (Default is 4444)\n | :param password: Password for the websocket server (Leave this field empty if no auth enabled\n | on the server)\n | \n | call(self, obj)\n | Make a call to the OBS server through the Websocket.\n | \n | :param obj: Request (class from obswebsocket.requests module) to send to the server.\n | :return: Request object populated with response data.\n | \n | connect(self, host=None, port=None)\n | Connect to the websocket server\n | \n | :return: Nothing\n | \n | disconnect(self)\n | Disconnect from websocket server\n | \n | :return: Nothing\n | \n | reconnect(self)\n | TODO (Not yet implemented)\n | \n | :return: Nothing\n | \n | register(self, function, event=None)\n | Register a new hook in the websocket client\n | \n | :param function: Callback function pointer for the hook\n | :param event: Event (class from obswebsocket.events module) to trigger the hook on.\n | Default is None, which means trigger on all events.\n | :return: Nothing\n | \n | send(self, data)\n | Make a raw json call to the OBS server through the Websocket.\n | \n | :param obj: Request (python dict) to send to the server. Do not include field \"message-id\".\n | :return: Response (python dict) from the server.\n | \n | unregister(self, function, event=None)\n | Unregister a new hook in the websocket client\n | \n | :param function: Callback function pointer for the hook\n | :param event: Event (class from obswebsocket.events module) which triggered the hook on.\n | Default is None, which means unregister this function for all events.\n | :return: Nothing\n```\n\n## Problems?\n\nPlease check on [Github project issues](https://github.com/Elektordi/obs-websocket-py/issues), and if nobody else have experienced it before, you can [file a new issue](https://github.com/Elektordi/obs-websocket-py/issues/new).\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/Elektordi/obs-websocket-py/archive/0.4.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Elektordi/obs-websocket-py", "keywords": "obs,obs-studio,websocket", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "obs-websocket-py", "package_url": "https://pypi.org/project/obs-websocket-py/", "platform": "", "project_url": "https://pypi.org/project/obs-websocket-py/", "project_urls": { "Download": "https://github.com/Elektordi/obs-websocket-py/archive/0.4.tar.gz", "Homepage": "https://github.com/Elektordi/obs-websocket-py" }, "release_url": "https://pypi.org/project/obs-websocket-py/0.4/", "requires_dist": [ "websocket-client" ], "requires_python": "", "summary": "Python library to communicate with an obs-websocket server.", "version": "0.4" }, "last_serial": 4442736, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "c2b7726fcebd50e90db09df20a254cf8", "sha256": "7d4c3c1011914bba17d4c76dc7118688be7fc7df1201a28a81362dfbeb23bc5b" }, "downloads": -1, "filename": "obs-websocket-py-0.1.tar.gz", "has_sig": false, "md5_digest": "c2b7726fcebd50e90db09df20a254cf8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9010, "upload_time": "2017-06-24T21:18:58", "url": "https://files.pythonhosted.org/packages/b3/27/409ffa7d41b3f74c684fa27e257db678afcc317ac0f5be4226794ae361f7/obs-websocket-py-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "b8e2a0c0809c122da38ba1e033d4f647", "sha256": "7dac0ac34ee4939600c06d8752ae39ddee311aebe715852f697f78849d3142c0" }, "downloads": -1, "filename": "obs-websocket-py-0.2.tar.gz", "has_sig": false, "md5_digest": "b8e2a0c0809c122da38ba1e033d4f647", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8979, "upload_time": "2017-07-28T20:17:41", "url": "https://files.pythonhosted.org/packages/e1/3f/473c2c66e67687b3e2387fdcb4766f1b1631403a250fefa2b489f779f0b8/obs-websocket-py-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "31504bf12e94f61852c3cb9365ada230", "sha256": "2194ef5c493671357594a544bad0d0ddb4d5fab75160719d4bd6f2fdb1b4eea8" }, "downloads": -1, "filename": "obs-websocket-py-0.3.tar.gz", "has_sig": false, "md5_digest": "31504bf12e94f61852c3cb9365ada230", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6354, "upload_time": "2018-02-04T00:29:38", "url": "https://files.pythonhosted.org/packages/2c/82/125306f049d7517f6cbae078fe0dc4cb82df08d5a2b1018b7bbd753eadc8/obs-websocket-py-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "23fae4cb3f0a68cdd000b2f4afe6e01b", "sha256": "77a765c1383421a1b218c30553f424700d0624f89af2f6cb16852bd10b64f144" }, "downloads": -1, "filename": "obs_websocket_py-0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "23fae4cb3f0a68cdd000b2f4afe6e01b", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 19823, "upload_time": "2018-11-01T23:35:34", "url": "https://files.pythonhosted.org/packages/0d/fa/766d75be93e1bc51eb3c8cce5b807b8d798878d97df12f3bbee10a40ae0f/obs_websocket_py-0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "84dc5626d3913d31fe1335ba3a4f1ac5", "sha256": "d7331ea327642e42f96cc18e7cc0cfb430ddf591fffb2f50d6a3ad60d5911e42" }, "downloads": -1, "filename": "obs-websocket-py-0.4.tar.gz", "has_sig": false, "md5_digest": "84dc5626d3913d31fe1335ba3a4f1ac5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18712, "upload_time": "2018-11-01T23:35:36", "url": "https://files.pythonhosted.org/packages/32/10/e3214c3298c0ae0f536916d8add8e98aa39f4e26f9dbd8360cdab4f68041/obs-websocket-py-0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "23fae4cb3f0a68cdd000b2f4afe6e01b", "sha256": "77a765c1383421a1b218c30553f424700d0624f89af2f6cb16852bd10b64f144" }, "downloads": -1, "filename": "obs_websocket_py-0.4-py2-none-any.whl", "has_sig": false, "md5_digest": "23fae4cb3f0a68cdd000b2f4afe6e01b", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 19823, "upload_time": "2018-11-01T23:35:34", "url": "https://files.pythonhosted.org/packages/0d/fa/766d75be93e1bc51eb3c8cce5b807b8d798878d97df12f3bbee10a40ae0f/obs_websocket_py-0.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "84dc5626d3913d31fe1335ba3a4f1ac5", "sha256": "d7331ea327642e42f96cc18e7cc0cfb430ddf591fffb2f50d6a3ad60d5911e42" }, "downloads": -1, "filename": "obs-websocket-py-0.4.tar.gz", "has_sig": false, "md5_digest": "84dc5626d3913d31fe1335ba3a4f1ac5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18712, "upload_time": "2018-11-01T23:35:36", "url": "https://files.pythonhosted.org/packages/32/10/e3214c3298c0ae0f536916d8add8e98aa39f4e26f9dbd8360cdab4f68041/obs-websocket-py-0.4.tar.gz" } ] }