Skip to content

Commit 7caf6a1

Browse files
committed
Update README.md and pyproject.toml
1 parent eea54a5 commit 7caf6a1

File tree

2 files changed

+45
-3
lines changed

2 files changed

+45
-3
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ This library differs from the official Stream Deck TypeScript SDK, as it aims to
2121

2222
- **PluginManager**: Orchestrates action lifecycle, event-routing, and context-gathering behind the scenes.
2323

24+
- **CLI Tool**: Quickly create new plugins projects from a template and package them to use on your Stream Deck using [the Python sdk cli tool](https://github.com/strohganoff/python-streamdeck-plugin-sdk-cli).
25+
2426
## Installation
2527

2628
You can install the library via pip:
@@ -187,6 +189,9 @@ And a command like the following is called by the Stream Deck software:
187189
streamdeck -port 28196 -pluginUUID 63831042F4048F072B096732E0385245 -registerEvent registerPlugin -info '{"application": {...}, "plugin": {"uuid": "my-plugin-name", "version": "1.1.3"}, ...}'
188190
```
189191

192+
## Creating and Packaging Plugins
193+
194+
To create a new plugin with all of the necessary files to start from and package it for use on your Stream Deck, use [the Python SDK CLI tool](https://github.com/strohganoff/python-streamdeck-plugin-sdk-cli).
190195

191196
## Contributing
192197

pyproject.toml

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,47 @@
1414
{ name = "strohganoff", email = "[email protected]" }
1515
]
1616
license = { file = "LICENSE" }
17-
keywords = ["example", "project", "setup"]
17+
keywords = [
18+
"python",
19+
"sdk",
20+
"streamdeck",
21+
"streamdeck_sdk",
22+
"streamdeck_plugin_sdk",
23+
"stream deck",
24+
"stream deck sdk",
25+
"stream deck plugin sdk",
26+
"streamdeck-sdk",
27+
"streamdeck-plugin-sdk",
28+
"stream-deck",
29+
"stream-deck-sdk",
30+
"stream-deck-plugin-sdk",
31+
"elgato",
32+
"elgato sdk",
33+
"elgato plugin",
34+
"elgato sdk",
35+
"elgato stream deck",
36+
"elgato stream deck sdk",
37+
"elgato stream deck plugin sdk",
38+
]
1839
classifiers = [
19-
"Development Status :: 3 - Alpha",
40+
"Intended Audience :: Developers",
41+
"Operating System :: OS Independent",
2042
"Programming Language :: Python :: 3",
43+
"Programming Language :: Python",
44+
"Programming Language :: Python :: 3 :: Only",
45+
"Programming Language :: Python :: 3.9",
46+
"Programming Language :: Python :: 3.10",
47+
"Programming Language :: Python :: 3.11",
48+
"Programming Language :: Python :: 3.12",
49+
"Development Status :: 4 - Beta",
50+
"Environment :: Desktop",
2151
"License :: OSI Approved :: MIT License",
22-
"Operating System :: OS Independent",
52+
"Topic :: CLI",
53+
"Topic :: Stream Deck",
54+
"Topic :: Stream Deck :: Plugin",
55+
"Topic :: Stream Deck :: Plugin :: SDK",
56+
"Topic :: Stream Deck :: SDK",
57+
"Typing :: Typed",
2358
]
2459
requires-python = ">=3.9"
2560
"dependencies" = [
@@ -45,6 +80,8 @@
4580
[project.urls]
4681
"Homepage" = "https://github.com/strohganoff/python-streamdeck-plugin-sdk"
4782
"Repository" = "https://github.com/strohganoff/python-streamdeck-plugin-sdk"
83+
"Documentation" = "https://docs.elgato.com/streamdeck/sdk/introduction/getting-started/"
84+
"Issues" = "https://github.com/strohganoff/python-streamdeck-plugin-sdk/issues"
4885

4986
[project.scripts]
5087
streamdeck = "streamdeck.__main__:main"

0 commit comments

Comments
 (0)