{"id":18554938,"url":"https://github.com/gri-gus/streamdeck-python-sdk","last_synced_at":"2025-08-22T00:32:08.491Z","repository":{"id":131790232,"uuid":"611708188","full_name":"gri-gus/streamdeck-python-sdk","owner":"gri-gus","description":"Library for creating Stream Deck plugins in Python.","archived":false,"fork":false,"pushed_at":"2024-12-02T00:47:38.000Z","size":701,"stargazers_count":19,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-02T01:26:52.919Z","etag":null,"topics":["python","streamdeck","streamdeck-plugin","streamdeck-python-sdk","streamdeck-sdk","streamdeckpython","streamdeckpythonsdk","streamdecksdk"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gri-gus.png","metadata":{"files":{"readme":"README-PYPI.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-09T11:37:29.000Z","updated_at":"2024-12-02T00:47:41.000Z","dependencies_parsed_at":"2024-03-18T07:29:08.761Z","dependency_job_id":"e6aff15d-894a-4290-a11e-e7344beee81f","html_url":"https://github.com/gri-gus/streamdeck-python-sdk","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gri-gus%2Fstreamdeck-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gri-gus%2Fstreamdeck-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gri-gus%2Fstreamdeck-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gri-gus%2Fstreamdeck-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gri-gus","download_url":"https://codeload.github.com/gri-gus/streamdeck-python-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230542288,"owners_count":18242332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","streamdeck","streamdeck-plugin","streamdeck-python-sdk","streamdeck-sdk","streamdeckpython","streamdeckpythonsdk","streamdecksdk"],"created_at":"2024-11-06T21:24:30.299Z","updated_at":"2024-12-20T06:07:05.998Z","avatar_url":"https://github.com/gri-gus.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n    \u003ca\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/gri-gus/streamdeck-python-sdk/main/assets/images/cover.png\" alt=\"streamdeck-python-sdk\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/streamdeck-sdk\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/v/streamdeck-sdk\" alt=\"PyPI\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/streamdeck-sdk\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://static.pepy.tech/badge/streamdeck-sdk\" alt=\"PyPI\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/Apache-2.0\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/License-Apache_2.0-blue.svg\" alt=\"Apache\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://docs.elgato.com/streamdeck/sdk/references/websocket/plugin\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://badgen.net/badge/Elgato/doc/blue\" alt=\"Elgato\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n      \u003ca href=\"https://github.com/gri-gus/streamdeck-python-sdk\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge\u0026logo=github\u0026logoColor=white\" alt=\"GitHub\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n# streamdeck-python-sdk\n\nLibrary for creating Stream Deck plugins in Python.\n\n**Supported operating systems:**\n\n* MacOS: 10.14 or later\n* Windows: 10 or later\n\n**Supported Python versions:** 3.8 or later\n\n## Installation\n\n\u003e ⚠️ For correct operation on Windows, it is recommended to enable `LongPaths` support in\n\u003e the system: [manual](https://www.backupery.com/how-to-enable-ntfs-long-paths-in-windows/).\n\u003e Without this setting, problems with installation and use may occur!\n\n```shell\npip install \"streamdeck-sdk[dev]\"\n```\n\nDuring this installation, additional libraries needed for development are installed:\n\n* [streamdeck-sdk-pi](https://pypi.org/project/streamdeck-sdk-pi) - Property Inspector generator in Python\n\n* [streamdeck-sdk-cli](https://pypi.org/project/streamdeck-sdk-cli) - useful command line utilities\n\n\u003e ⚠️ These libraries should not be present in the plugin's `requirements.txt`.\n\n## Features\n\n* Ease of use. You can quickly create your own plugin without having to understand how websockets and\n  other technologies 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* Debug mode via `PyCharm` or other debugging tools.\n* A complete protocol for interaction with the Stream Deck application has been implemented.\n* Quick start of a project via the console command `streamdeck_sdk startproject`.\n* Build the project using the `streamdeck_sdk build` console command.\n* Property Inspector Generator. Write code in Python and get html and js for PI.\n\n## ⚠️ Limitations\n\n1. During installation and update of the plugin, the Internet must be available.\n\n### Windows\n\n1. Plugin requirements should take no longer than 30 seconds to install. This is a feature of Stream Deck on Windows,\n   since the program restarts the plugin if a websocket connection has not been established within 30 seconds.\n   Therefore, you need a good Internet connection when installing and updating the plugin.\n\n## Examples\n\n[LoremFlickr](https://github.com/gri-gus/loremflickr-streamdeck-plugin) - Plugin for installing images on a button from\nthe LoremFlickr site. Supports MacOS and Windows.\n\n[Proxy Manager](https://github.com/gri-gus/proxymanager-streamdeck-plugin) - Plugin for enabling and disabling\nproxies on MacOS. Periodically polls the proxy status through a separate thread.\n\n[One-time password](https://github.com/gri-gus/otp-streamdeck-plugin) - Plugin for generating one-time passwords,\nlike in Google Authenticator. Has several Actions. Supports MacOS and Windows.\n\n---\n\nSee full description and usage examples on\n[GitHub](https://github.com/gri-gus/streamdeck-python-sdk)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgri-gus%2Fstreamdeck-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgri-gus%2Fstreamdeck-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgri-gus%2Fstreamdeck-python-sdk/lists"}