Project name

Switching to from a quite boring working title to the final project
name.

README.md

@@ -1,3 +1,3 @@
-# deckconnect
+# knoepfe
 
 Connect and control Elgato Stream Decks

deckconnect/__main__.py → knoepfe/__main__.py

@@ -1,11 +1,11 @@
-"""deckconnect
+"""knoepfe
 
 Connect and control Elgato Stream Decks
 
 Usage:
-  deckconnect [(-v | --verbose)] [--config=<path>]
-  deckconnect (-h | --help)
-  deckconnect --version
+  knoepfe [(-v | --verbose)] [--config=<path>]
+  knoepfe (-h | --help)
+  knoepfe --version
 
 Options:
   -h --help       Show this screen.
@@ -24,10 +24,10 @@
 from StreamDeck.Devices import StreamDeck
 from StreamDeck.Transport.Transport import TransportError
 
-from deckconnect import __version__, log
-from deckconnect.config import process_config
-from deckconnect.deckmanager import DeckManager
-from deckconnect.log import debug, error, info
+from knoepfe import __version__, log
+from knoepfe.config import process_config
+from knoepfe.deckmanager import DeckManager
+from knoepfe.log import debug, error, info
 
 
 async def connect_device() -> StreamDeck:

deckconnect/config.py → knoepfe/config.py

@@ -5,8 +5,8 @@
 import appdirs
 from schema import And, Optional, Schema
 
-from deckconnect.deck import Deck
-from deckconnect.widgets.base import Widget
+from knoepfe.deck import Deck
+from knoepfe.widgets.base import Widget
 
 DeckConfig = TypedDict("DeckConfig", {"id": str, "widgets": List[Widget | None]})
 

deckconnect/deck.py → knoepfe/deck.py

@@ -4,12 +4,12 @@
 
 from StreamDeck.Devices import StreamDeck
 
-from deckconnect.key import Key
-from deckconnect.log import debug
-from deckconnect.wakelock import WakeLock
+from knoepfe.key import Key
+from knoepfe.log import debug
+from knoepfe.wakelock import WakeLock
 
 if TYPE_CHECKING:  # pragma: no cover
-    from deckconnect.widgets.base import Widget
+    from knoepfe.widgets.base import Widget
 
 
 class SwitchDeckException(BaseException):

deckconnect/deckmanager.py → knoepfe/deckmanager.py

@@ -4,9 +4,9 @@
 
 from StreamDeck.Devices import StreamDeck
 
-from deckconnect.deck import Deck, SwitchDeckException
-from deckconnect.log import debug, error
-from deckconnect.wakelock import WakeLock
+from knoepfe.deck import Deck, SwitchDeckException
+from knoepfe.log import debug, error
+from knoepfe.wakelock import WakeLock
 
 
 class DeckManager:
@@ -19,7 +19,7 @@ def __init__(
     ) -> None:
         self.active_deck = active_deck
         self.decks = decks
-        device_config = global_config.get("deckconnect.config.device", {})
+        device_config = global_config.get("knoepfe.config.device", {})
         self.brightness = device_config.get("brightness", 100)
         self.device_poll_frequency = device_config.get("device_poll_frequency", 5)
         self.sleep_timeout = device_config.get("sleep_timeout", None)

knoepfe/default.cfg

@@ -0,0 +1,33 @@
+config({
+  'type': 'knoepfe.config.device',
+  'brightness': 100,
+  'sleep_timeout': 10.0,
+  'device_poll_frequency': 5,
+})
+
+config({
+  'type': 'knoepfe.widgets.obs.config',
+  'host': 'localhost',
+  'port': 4444,
+  'password': 'supersecret',
+})
+
+default_deck({
+  'id': 'main',
+  'widgets': [
+    widget({'type': 'knoepfe.widgets.MicMute'}),
+    widget({'type': 'knoepfe.widgets.Timer'}),
+    widget({'type': 'knoepfe.widgets.Clock', 'format': '%H:%M'}),
+    widget({'type': 'knoepfe.widgets.obs.Recording'}),
+    widget({'type': 'knoepfe.widgets.obs.Streaming'}),
+    widget({'type': 'knoepfe.widgets.obs.CurrentScene', 'switch_deck': 'scenes'}),
+  ],
+})
+
+deck({
+  'id': 'scenes',
+  'widgets': [
+    widget({'type': 'knoepfe.widgets.obs.SwitchScene', 'scene': 'Scene', 'switch_deck': 'main'}),
+    widget({'type': 'knoepfe.widgets.obs.SwitchScene', 'scene': 'Other Scene', 'switch_deck': 'main'}),
+  ],
+})

knoepfe/widgets/__init__.py

@@ -0,0 +1,6 @@
+from knoepfe.widgets.clock import Clock
+from knoepfe.widgets.mic_mute import MicMute
+from knoepfe.widgets.text import Text
+from knoepfe.widgets.timer import Timer
+
+__all__ = ["Text", "MicMute", "Clock", "Timer"]

deckconnect/widgets/base.py → knoepfe/widgets/base.py

@@ -3,9 +3,9 @@
 
 from schema import Optional, Schema
 
-from deckconnect.deck import SwitchDeckException
-from deckconnect.key import Key
-from deckconnect.wakelock import WakeLock
+from knoepfe.deck import SwitchDeckException
+from knoepfe.key import Key
+from knoepfe.wakelock import WakeLock
 
 
 class Widget:

deckconnect/widgets/clock.py → knoepfe/widgets/clock.py

@@ -3,8 +3,8 @@
 
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.base import Widget
+from knoepfe.key import Key
+from knoepfe.widgets.base import Widget
 
 
 class Clock(Widget):

deckconnect/widgets/mic_mute.py → knoepfe/widgets/mic_mute.py

@@ -5,9 +5,9 @@
 from pulsectl_asyncio import PulseAsync
 from schema import Optional, Schema
 
-from deckconnect.key import Key
-from deckconnect.log import error
-from deckconnect.widgets.base import Widget
+from knoepfe.key import Key
+from knoepfe.log import error
+from knoepfe.widgets.base import Widget
 
 
 class MicMute(Widget):

knoepfe/widgets/obs/__init__.py

@@ -0,0 +1,7 @@
+from knoepfe.widgets.obs.connector import config
+from knoepfe.widgets.obs.current_scene import CurrentScene
+from knoepfe.widgets.obs.recording import Recording
+from knoepfe.widgets.obs.streaming import Streaming
+from knoepfe.widgets.obs.switch_scene import SwitchScene
+
+__all__ = ["config", "Recording", "Streaming", "CurrentScene", "SwitchScene"]

deckconnect/widgets/obs/base.py → knoepfe/widgets/obs/base.py

@@ -1,8 +1,8 @@
 from asyncio import Task, get_event_loop
 from typing import Any, Dict, List
 
-from deckconnect.widgets.base import Widget
-from deckconnect.widgets.obs.connector import obs
+from knoepfe.widgets.base import Widget
+from knoepfe.widgets.obs.connector import obs
 
 
 class OBSWidget(Widget):
@@ -15,7 +15,7 @@ def __init__(
         self.listening_task: Task[None] | None = None
 
     async def activate(self) -> None:
-        await obs.connect(self.global_config.get("deckconnect.widgets.obs.config", {}))
+        await obs.connect(self.global_config.get("knoepfe.widgets.obs.config", {}))
 
         if not self.listening_task:
             self.listening_task = get_event_loop().create_task(self.listener())

deckconnect/widgets/obs/connector.py → knoepfe/widgets/obs/connector.py

@@ -14,7 +14,7 @@
 )
 from schema import Optional, Schema
 
-from deckconnect.log import debug, info
+from knoepfe.log import debug, info
 
 config = Schema(
     {

deckconnect/widgets/obs/current_scene.py → knoepfe/widgets/obs/current_scene.py

@@ -1,8 +1,8 @@
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.obs.base import OBSWidget
-from deckconnect.widgets.obs.connector import obs
+from knoepfe.key import Key
+from knoepfe.widgets.obs.base import OBSWidget
+from knoepfe.widgets.obs.connector import obs
 
 
 class CurrentScene(OBSWidget):

deckconnect/widgets/obs/recording.py → knoepfe/widgets/obs/recording.py

@@ -3,9 +3,9 @@
 
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.obs.base import OBSWidget
-from deckconnect.widgets.obs.connector import obs
+from knoepfe.key import Key
+from knoepfe.widgets.obs.base import OBSWidget
+from knoepfe.widgets.obs.connector import obs
 
 
 class Recording(OBSWidget):

deckconnect/widgets/obs/streaming.py → knoepfe/widgets/obs/streaming.py

@@ -3,9 +3,9 @@
 
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.obs.base import OBSWidget
-from deckconnect.widgets.obs.connector import obs
+from knoepfe.key import Key
+from knoepfe.widgets.obs.base import OBSWidget
+from knoepfe.widgets.obs.connector import obs
 
 
 class Streaming(OBSWidget):

deckconnect/widgets/obs/switch_scene.py → knoepfe/widgets/obs/switch_scene.py

@@ -1,8 +1,8 @@
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.obs.base import OBSWidget
-from deckconnect.widgets.obs.connector import obs
+from knoepfe.key import Key
+from knoepfe.widgets.obs.base import OBSWidget
+from knoepfe.widgets.obs.connector import obs
 
 
 class SwitchScene(OBSWidget):

deckconnect/widgets/text.py → knoepfe/widgets/text.py

@@ -1,7 +1,7 @@
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.base import Widget
+from knoepfe.key import Key
+from knoepfe.widgets.base import Widget
 
 
 class Text(Widget):

deckconnect/widgets/timer.py → knoepfe/widgets/timer.py

@@ -4,8 +4,8 @@
 
 from schema import Schema
 
-from deckconnect.key import Key
-from deckconnect.widgets.base import Widget
+from knoepfe.key import Key
+from knoepfe.widgets.base import Widget
 
 
 class Timer(Widget):

pyproject.toml

@@ -1,12 +1,12 @@
 [tool.poetry]
-name = "deckconnect"
+name = "knoepfe"
 version = "0.1.0"
 description = "Connect and control Elgato Stream Decks"
 authors = ["Simon Hayessen <simon@lnqs.io>"]
 license = "GPL-3.0-or-later"
 readme = "README.md"
-homepage = "https://github.com/lnqs/deckconnect"
-repository = "https://github.com/lnqs/deckconnect"
+homepage = "https://github.com/lnqs/knoepfe"
+repository = "https://github.com/lnqs/knoepfe"
 
 [tool.poetry.dependencies]
 python = "^3.10"
@@ -33,14 +33,14 @@ types-Pillow = "^9.0.6"
 pytest-asyncio = "^0.18.1"
 
 [tool.poetry.scripts]
-deckconnect = 'deckconnect.__main__:main'
+knoepfe = 'knoepfe.__main__:main'
 
 [tool.isort]
 profile = "black"
 
 [tool.pytest.ini_options]
 filterwarnings = "ignore::DeprecationWarning:pulsectl_asyncio"
-addopts = "--cov=deckconnect --cov-report=term-missing --asyncio-mode=auto"
+addopts = "--cov=knoepfe --cov-report=term-missing --asyncio-mode=auto"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]