From 26742cdaf036cbdbcde7e7d54b954b7174c742a3 Mon Sep 17 00:00:00 2001 From: Benjamin Braatz Date: Fri, 5 Mar 2021 01:32:39 +0100 Subject: [PATCH] Move controlpi.plugins to controlpi-plugins Namespace packages should not be inside regular packages: https://stackoverflow.com/a/62992832 --- {controlpi/plugins => controlpi-plugins}/util.py | 0 controlpi/__init__.py | 2 +- doc/index.md | 6 +++--- setup.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) rename {controlpi/plugins => controlpi-plugins}/util.py (100%) diff --git a/controlpi/plugins/util.py b/controlpi-plugins/util.py similarity index 100% rename from controlpi/plugins/util.py rename to controlpi-plugins/util.py diff --git a/controlpi/__init__.py b/controlpi/__init__.py index 8657d2a..176a1c0 100644 --- a/controlpi/__init__.py +++ b/controlpi/__init__.py @@ -257,7 +257,7 @@ async def run(conf: Configuration) -> None: """ if not conf or not check_configuration(conf): return - plugins = PluginRegistry('controlpi.plugins', BasePlugin) + plugins = PluginRegistry('controlpi-plugins', BasePlugin) message_bus = MessageBus() coroutines = [message_bus.run()] for instance_name in conf: diff --git a/doc/index.md b/doc/index.md index bdfff6a..b0fe96f 100644 --- a/doc/index.md +++ b/doc/index.md @@ -91,8 +91,8 @@ Die ControlPi-Infrastruktur hat zwei Haupt-Bestandteile: weitere Plugin-Klassen in Python zu implementieren und (in anderen Code-Repositories und anderen Distributions-Paketen) zum System hinzuzufügen. - Im Modul `controlpi.plugins.util` bzw. der Datei - `controlpi/plugins/util.py` befindet sich eine Reihe nützlicher + Im Modul `controlpi-plugins.util` bzw. der Datei + `controlpi-plugins/util.py` befindet sich eine Reihe nützlicher Standard-Plugins, an denen die generelle Struktur nachvollzogen werden kann. - Ein Nachrichten-Bus erlaubt den Austausch von Nachrichten zwischen allen @@ -119,7 +119,7 @@ Nachrichten. Sie müssen nicht unbedingt bestimmte Empfänger haben, sie gehören nicht unbedingt zu einem bestimmten Typen etc. -Einige Konventionen, die z.B. von den Plugins in `controlpi.plugins.util` +Einige Konventionen, die z.B. von den Plugins in `controlpi-plugins.util` eingehalten werden, sind aber: - Einige Nachrichten signalisieren, dass ein Ereignis eingetreten ist. Sie haben in der Regel einen Schlüssel `'event'` mit einem Wert, der die diff --git a/setup.py b/setup.py index fb945fd..af67d93 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ setuptools.setup( long_description=long_description, long_description_content_type="text/markdown", url="http://docs.graph-it.com/graphit/controlpi", - packages=["controlpi", "controlpi.plugins"], + packages=["controlpi", "controlpi-plugins"], package_data={"controlpi": ["py.typed"]}, zip_safe=False, extras_require={ -- 2.34.1