streamdeck_manager's Introduction

Streamdeck manager POC

Library to manage elgato stream deck in a easy way with several use cases implemented.

This library have been tested with:

Stream deck model used have 3x5 buttons with 72x72 pixels of resolution each one.

Installation

To install library dependencies take a loog into docs/installation.md:

Fedora: Working.
Ubuntu: Working.
WSL2: Not USB support yet.

Development

Follow installation instruction and instead install streamdeck_manager:

make env-create                                 # Only first time
source .tox/streamdeck_manager/bin/activate     # All bash session

Samples

In a development bash, use --help to customize parameters. If you install the library a default folder with assets is installed. You may give another asset path to make them work with your custom assets.

If you install the library use the entrypoint running the command in your bash. In development you can run them directly the script given. Both support same options.

Device info

Read the HW info and print in stdout.

python streamdeck_manager/samples/device_info.py

Entrypoint: sdm-info

Basic buttons

Basic panel with buttons and callbacks.

python streamdeck_manager/samples/basic_usage.py

Entrypoint: sdm-basic

More buttons

Another panel with different type of buttons.

python streamdeck_manager/samples/buttons_types.py

Entrypoint: sdm-more-buttons

Background photo

Set up a background image.

python streamdeck_manager/samples/tiled_image.py

Entrypoint: sdm-background

Menu widget

Run a Finite state machine with all buttons to navigate in several pages, the FSM run iterations times (reset with back button).

python streamdeck_manager/samples/menu.py --iterations 2

Entrypoint: sdm-menu

Navigation widget

Run a Finite state machine with all buttons to navigate in a folder path. It shows folders and files with icon if provided in the asset path.

python streamdeck_manager/samples/navigator.py --root-path $HOME

Entrypoint: sdm-navigator

Credits

vgonisanz
streamdeck library base from https://github.com/abcminiuser/python-elgato-streamdeck

streamdeck_manager's People

Contributors

Stargazers

Watchers

streamdeck_manager's Issues

Suggest to loosen the dependency on transitions

Hi, your project streamdeck_manager requires "transitions==0.8.10" in its dependency. After analyzing the source code, we found that some other versions of transitions can also be suitable without affecting your project, i.e., transitions 0.8.11. Therefore, we suggest to loosen the dependency on transitions from "transitions==0.8.10" to "transitions>=0.8.10,<=0.8.11" to avoid any possible conflict for importing more packages or for downstream projects that may use streamdeck_manager.

May I pull a request to loosen the dependency on transitions?

By the way, could you please tell us whether such dependency analysis may be potentially helpful for maintaining dependencies easier during your development?

For your reference, here are details in our analysis.

Your project streamdeck_manager(commit id: f022094) directly uses 1 APIs from package transitions.

transitions.core.Machine.__init__

From which, 22 functions are then indirectly called, including 16 transitions's internal APIs and 6 outsider APIs, as follows (neglecting some repeated function occurrences).

[/vgonisanz/streamdeck_manager]
+--transitions.core.Machine.__init__
|      +--collections.deque
|      +--collections.OrderedDict
|      +--transitions.core.Machine.add_states
|      |      +--transitions.core.listify
|      |      +--transitions.core.Machine._create_state
|      |      +--transitions.core.Machine._add_model_to_state
|      |      |      +--functools.partial
|      |      |      +--transitions.core.Machine._checked_assignment
|      |      |      +--inspect.ismethod
|      |      +--collections.OrderedDict.keys
|      |      +--transitions.core.Machine.add_transition
|      |      |      +--transitions.core.Machine._create_event
|      |      |      +--transitions.core.Machine._add_trigger_to_model
|      |      |      |      +--transitions.core.Machine._checked_assignment
|      |      |      |      +--functools.partial
|      |      |      +--collections.OrderedDict.keys
|      |      |      +--transitions.core.listify
|      |      |      +--transitions.core.Machine._has_state
|      |      |      |      +--collections.OrderedDict.values
|      |      |      +--transitions.core.Machine._create_transition
|      |      +--functools.partial
|      +--transitions.core.Machine.add_transitions
|      |      +--transitions.core.listify
|      |      +--transitions.core.Machine.add_transition
|      +--transitions.core.Machine.add_ordered_transitions
|      |      +--collections.OrderedDict.keys
|      |      +--transitions.core._prep_ordered_arg
|      |      |      +--transitions.core.listify
|      |      +--transitions.core.Machine.add_transition
|      +--transitions.core.Machine.add_model
|      |      +--transitions.core.listify
|      |      +--transitions.core.Machine._checked_assignment
|      |      +--collections.OrderedDict.values
|      |      +--transitions.core.Machine.set_state
|      |      |      +--transitions.core.Machine.get_state
|      |      |      +--transitions.core.listify
|      |      +--functools.partial
|      |      +--transitions.core.Machine._add_trigger_to_model
|      |      +--transitions.core.Machine._add_model_to_state

We scan transitions's versions among [0.8.11] and 0.8.10, the changing functions (diffs being listed below) have none intersection with any function or API we mentioned above (either directly or indirectly called by this project).

diff: 0.8.10(original) 0.8.11
['transitions.extensions.states.Timeout', 'transitions.extensions.states.Timeout.enter']

As for other packages, the APIs of @outside_package_name are called by transitions in the call graph and the dependencies on these packages also stay the same in our suggested versions, thus avoiding any outside conflict.

Therefore, we believe that it is quite safe to loose your dependency on transitions from "transitions==0.8.10" to "transitions>=0.8.10,<=0.8.11". This will improve the applicability of streamdeck_manager and reduce the possibility of any further dependency conflict with other projects/packages.

Recommend Projects

vgonisanz / streamdeck_manager Goto Github PK