<p align="center">
<a>
<img src="https://raw.githubusercontent.com/gri-gus/streamdeck-python-sdk/main/assets/images/cover.png" alt="streamdeck-python-sdk">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/streamdeck-sdk" target="_blank">
<img src="https://img.shields.io/pypi/v/streamdeck-sdk" alt="PyPI">
</a>
<a href="https://pypi.org/project/streamdeck-sdk" target="_blank">
<img src="https://static.pepy.tech/badge/streamdeck-sdk" alt="PyPI">
</a>
<a href="https://opensource.org/licenses/Apache-2.0" target="_blank">
<img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Apache">
</a>
<a href="https://developer.elgato.com/documentation/stream-deck/sdk/overview/" target="_blank">
<img src="https://badgen.net/badge/Elgato/doc/blue" alt="Elgato">
</a>
</p>
# streamdeck-python-sdk
Library for creating Stream Deck plugins in Python.
**PyPi**: https://pypi.org/project/streamdeck-sdk/
**Supported operating systems:**
* MacOS: 10.14 or later
* Windows: 10 or later
**Supported Stream Deck application:** 6.0, 6.1, 6.2
**Supported Python:** 3.7 or later
## Installation
```shell
pip install streamdeck-sdk
```
or
```shell
pip install streamdeck_sdk
```
## Features
* Easy use. You can quickly create your own plugin without having to understand how websockets and other complicated
things work.
* Fully typed, using [pydantic](https://github.com/pydantic/pydantic).
* Includes image to base64 converters for easy installation of icons on keys.
* Includes a decorator for functions and methods to run on a separate thread.
* Exception logging and easy logging configuration.
## Examples
[LoremFlickr](https://github.com/gri-gus/loremflickr-streamdeck-plugin) - Plugin for installing images from LoremFlickr
to button. Supports MacOS and Windows.
---
> 🧑💻 Documentation under development
Raw data
{
"_id": null,
"home_page": "https://github.com/gri-gus/streamdeck-python-sdk",
"name": "streamdeck-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,sdk,streamdeck,streamdeck-sdk,streamdeck_sdk,stream deck sdk,stream deck,elgato,elgato sdk,elgato stream deck,streamdeck-python-sdk,streamdeck_python_sdk,streamdeck python sdk",
"author": "Grigoriy Gusev",
"author_email": "thegrigus@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/47/13/8c261735a69795fd66e594d61e08e01480956cff414fda559fd8687e5e3e/streamdeck_sdk-0.3.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a>\n <img src=\"https://raw.githubusercontent.com/gri-gus/streamdeck-python-sdk/main/assets/images/cover.png\" alt=\"streamdeck-python-sdk\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/streamdeck-sdk\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/streamdeck-sdk\" alt=\"PyPI\">\n </a>\n <a href=\"https://pypi.org/project/streamdeck-sdk\" target=\"_blank\">\n <img src=\"https://static.pepy.tech/badge/streamdeck-sdk\" alt=\"PyPI\">\n </a>\n <a href=\"https://opensource.org/licenses/Apache-2.0\" target=\"_blank\">\n <img src=\"https://img.shields.io/badge/License-Apache_2.0-blue.svg\" alt=\"Apache\">\n </a>\n <a href=\"https://developer.elgato.com/documentation/stream-deck/sdk/overview/\" target=\"_blank\">\n <img src=\"https://badgen.net/badge/Elgato/doc/blue\" alt=\"Elgato\">\n </a>\n</p>\n\n# streamdeck-python-sdk\n\nLibrary for creating Stream Deck plugins in Python.\n\n**PyPi**: https://pypi.org/project/streamdeck-sdk/\n\n**Supported operating systems:**\n\n* MacOS: 10.14 or later\n* Windows: 10 or later\n\n**Supported Stream Deck application:** 6.0, 6.1, 6.2\n\n**Supported Python:** 3.7 or later\n\n## Installation\n\n```shell\npip install streamdeck-sdk\n```\n\nor\n\n```shell\npip install streamdeck_sdk\n```\n\n## Features\n\n* Easy use. You can quickly create your own plugin without having to understand how websockets and other complicated\n things work.\n* Fully typed, using [pydantic](https://github.com/pydantic/pydantic).\n* Includes image to base64 converters for easy installation of icons on keys.\n* Includes a decorator for functions and methods to run on a separate thread.\n* Exception logging and easy logging configuration.\n\n## Examples\n\n[LoremFlickr](https://github.com/gri-gus/loremflickr-streamdeck-plugin) - Plugin for installing images from LoremFlickr\nto button. Supports MacOS and Windows.\n\n---\n> \ud83e\uddd1\u200d\ud83d\udcbb Documentation under development\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Library for creating Stream Deck plugins in Python.",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/gri-gus/streamdeck-python-sdk"
},
"split_keywords": [
"python",
"sdk",
"streamdeck",
"streamdeck-sdk",
"streamdeck_sdk",
"stream deck sdk",
"stream deck",
"elgato",
"elgato sdk",
"elgato stream deck",
"streamdeck-python-sdk",
"streamdeck_python_sdk",
"streamdeck python sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19802add8c0099d8f4c6b9bc01696ac191eb26134b8a095ffbad8cbd17d020f0",
"md5": "a683249175d75edab888ceba7951ef80",
"sha256": "614762da02997d578f4a880d6cd99afcd8c1d2e705c08876369609e7647de702"
},
"downloads": -1,
"filename": "streamdeck_sdk-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a683249175d75edab888ceba7951ef80",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 15328,
"upload_time": "2023-05-09T20:33:20",
"upload_time_iso_8601": "2023-05-09T20:33:20.593356Z",
"url": "https://files.pythonhosted.org/packages/19/80/2add8c0099d8f4c6b9bc01696ac191eb26134b8a095ffbad8cbd17d020f0/streamdeck_sdk-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47138c261735a69795fd66e594d61e08e01480956cff414fda559fd8687e5e3e",
"md5": "c39102da533b243ef5af890b3072a239",
"sha256": "0128233c1edc7a922bfc6d4eef7501f2fdebe3d6f8485b1c1e755497e3228680"
},
"downloads": -1,
"filename": "streamdeck_sdk-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "c39102da533b243ef5af890b3072a239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 13577,
"upload_time": "2023-05-09T20:34:26",
"upload_time_iso_8601": "2023-05-09T20:34:26.495978Z",
"url": "https://files.pythonhosted.org/packages/47/13/8c261735a69795fd66e594d61e08e01480956cff414fda559fd8687e5e3e/streamdeck_sdk-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-09 20:34:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gri-gus",
"github_project": "streamdeck-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "streamdeck-sdk"
}
JSON
