streamdeck-python-sdk
Library for creating Stream Deck plugins in Python.
Supported operating systems:
- MacOS: 10.14 or later
- Windows: 10 or later
Supported Python versions: 3.8 or later
Installation
⚠️ For correct operation on Windows, it is recommended to enable
LongPathssupport in the system: manual. Without this setting, problems with installation and use may occur!
pip install "streamdeck-sdk[dev]"
During this installation, additional libraries needed for development are installed:
-
streamdeck-sdk-pi - Property Inspector generator in Python
-
streamdeck-sdk-cli - useful command line utilities
⚠️ These libraries should not be present in the plugin's
requirements.txt.
Features
- Ease of use. You can quickly create your own plugin without having to understand how websockets and other technologies work.
- Fully typed, using 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.
- Debug mode via
PyCharmor other debugging tools. - A complete protocol for interaction with the Stream Deck application has been implemented.
- Quick start of a project via the console command
streamdeck_sdk startproject. - Build the project using the
streamdeck_sdk buildconsole command. - Property Inspector Generator. Write code in Python and get html and js for PI.
⚠️ Limitations
- During installation and update of the plugin, the Internet must be available.
Windows
- Plugin requirements should take no longer than 30 seconds to install. This is a feature of Stream Deck on Windows, since the program restarts the plugin if a websocket connection has not been established within 30 seconds. Therefore, you need a good Internet connection when installing and updating the plugin.
Examples
LoremFlickr - Plugin for installing images on a button from the LoremFlickr site. Supports MacOS and Windows.
Proxy Manager - Plugin for enabling and disabling proxies on MacOS. Periodically polls the proxy status through a separate thread.
One-time password - Plugin for generating one-time passwords, like in Google Authenticator. Has several Actions. Supports MacOS and Windows.
See full description and usage examples on GitHub
1 maintainer
Metadata
1 maintainer
Release files for streamdeck-sdk 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| streamdeck_sdk-1.2.1.tar.gz | 32.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| streamdeck_sdk-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 81.4 kB
Release files / streamdeck_sdk-1.2.1.tar.gz
| Download URL | streamdeck_sdk-1.2.1.tar.gz |
|---|---|
| Size | 32.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4bb97ec62206a70ce0d154ec8a30695b7462d41fb1032d0f51d3e986a72eef04
|
|
BLAKE2b-256 checksum How to use checksums |
d42845a6c41739dc280220fcb8f58d10b94a9ea81701e756a2f8757527ddd231
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.4
|
Release files / streamdeck_sdk-1.2.1-py3-none-any.whl
| Download URL | streamdeck_sdk-1.2.1-py3-none-any.whl |
|---|---|
| Size | 49.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cbfc416f1d8231b021bf9191000cc4269288c52a4ea0430ea97c7512414e9485
|
|
BLAKE2b-256 checksum How to use checksums |
89c3e63d5005817ded92bf50252f921837b431a652223762aaf8ce82c8565b6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.4
|
