Skip to main content

Library for creating Stream Deck plugins in Python.

Project description

streamdeck-python-sdk

PyPI PyPI Apache Elgato

GitHub

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

⚠️ To work correctly on Windows, you need to enable LongPaths support in the system: manual. Without this setting, installation problems may occur!

pip install streamdeck-sdk

or

pip install streamdeck_sdk

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 PyCharm or 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 build console command.
  • Property Inspector Generator. Write code in Python and get html and js for PI.

⚠️ Limitations

  1. During installation and update of the plugin, the Internet must be available.

Windows

  1. 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.

  2. You need to enable LongPaths support in the system registry: manual.

    Without this setting, the created plugins will not work!

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

streamdeck_sdk-1.1a3.tar.gz (476.1 kB view hashes)

Uploaded Source

Built Distribution

streamdeck_sdk-1.1a3-py3-none-any.whl (522.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page