Merge pull request 'Updated project description. /JL' (#35) from 0.3.3 into main

Reviewed-on: https://gitea.com/Lerking/XtendR/pulls/35

README.md

@@ -1,6 +1,6 @@
 # XtendR
 
-A very basic Python 3.12 plugin system based on the K.I.S.S principle.
+A very basic Python 3.12 friendly plugin system based on the K.I.S.S principle.
 
 I was in need of a new plugin system, which should meet these requirements:  
 :heavy_plus_sign: Simple to use  
@@ -16,7 +16,8 @@ I didn't find anything that suited my needs, so I decided to make my own plugin
 It simply contains 2 classes, one for the plugin system and one abstraction base class for the plugins themselves.
 
 At the moment only 4 functions are available:
-- Attach
+
+- Attach - including call to pre-load data in plugin.
 - Run
 - Stop
 - Detach
@@ -27,4 +28,4 @@ The Run and Stop functions are mandatory in the plugin modules.
 The system expects a folder called 'plugins', placed at the root, along side your main python file.
 Each plugin should be placed in subfolders, named as the plugin, inside the 'plugins' folder.
 
-The example.py along with the plugins/example_plugin/example_plugin.py and plugins/example_plugin/example_plugin.json shows the workings of this plugin system.
+The example.py along with the plugins/example_plugin/example_plugin.py and plugins/example_plugin/example_plugin.json shows the workings of this plugin system.

example.py

@@ -1,5 +1,9 @@
+import time
 from xtendr.xtendrsystem import XtendRSystem
 
+def my_callback():
+    print("'example_plugin is finished pre-loading")
+    
 if __name__ == "__main__":
     """Example usage of the PluginSystem.
     
@@ -15,7 +19,14 @@ if __name__ == "__main__":
     Detached plugin 'example_plugin'.
     """
     system = XtendRSystem()
-    system.attach("example_plugin")  # Assuming 'example_plugin/plugin_info.json' exists
-    system.run("example_plugin")
+    system.attach("example_plugin", my_callback)  # Assuming 'example_plugin/plugin_info.json' exists
+    for i in range(3):
+        print(f"Main program is running iteration {i+1}...")
+        time.sleep(2)
+    system.run("example_plugin", test="Hello!")
+    system.stop("example_plugin")
+    system.run("example_plugin", 25)
+    system.stop("example_plugin")
+    system.run("example_plugin", "Hello!", 25)
     system.stop("example_plugin")
     system.detach("example_plugin")

plugins/example_plugin/example_plugin.py

@@ -1,3 +1,5 @@
+import threading
+import time
 from xtendr.xtendrbase import XtendRBase
 
 class ExamplePlugin(XtendRBase):
@@ -5,13 +7,33 @@ class ExamplePlugin(XtendRBase):
     
     Example:
     >>> plugin = ExamplePlugin()
-    >>> plugin.run()
+    >>> plugin.run("Hello!", 25)
+    Passed arguments 2:
+    Argument 0: Hello!
+    Argument 1: 25
     ExamplePlugin is running!
     >>> plugin.stop()
     ExamplePlugin has stopped!
     """
-    def run(self):
+    def run(self, *args, **kwargs):
+        arglen = len(args)
+        keylen = len(kwargs)
+        if arglen > 0:
+            print(f"Passed arguments {arglen}:")
+            for idx, a in enumerate(args):
+                print(f"Argument {idx}: {a}")
+        if keylen > 0:
+            print(f"Keyword arguments passed {keylen}")
+            if not "test" in kwargs:
+                raise ValueError("Didn't get expected 'test' keyword!")
+            for kw in kwargs:
+                print(f"Argument {kw}: {kwargs[kw]}")
+
         print("ExamplePlugin is running!")
     
     def stop(self):
         print("ExamplePlugin has stopped!")
+
+    def pre_load(self, callback):
+        time.sleep(5) # Indicate long running pre-load.
+        callback()

requirements.txt

@@ -0,0 +1 @@
+setuptools==68.2.2

setup.py

@@ -1,9 +1,12 @@
 if __name__ == "__main__":
     from setuptools import setup, find_packages
-    
+    from pathlib import Path
+    this_directory = Path(__file__).parent
+    long_description = (this_directory / "README.md").read_text()
+
     setup(
         name="XtendR",
-        version="0.1.2",
+        version="0.3.3.1",
         packages=find_packages(),
         install_requires=[],
         author="Jan Lerking",
@@ -16,4 +19,6 @@ if __name__ == "__main__":
             "Operating System :: OS Independent",
         ],
         python_requires='>=3.11',
+        long_description=long_description,
+        long_description_content_type='text/markdown'
     )

xtendr/xtendrbase.py

@@ -17,9 +17,14 @@ class XtendRBase(ABC):
     Stopping TestPlugin
     """
     @abstractmethod
-    def run(self):
+    def run(self, *args, **kwargs):
         pass
     
     @abstractmethod
     def stop(self):
         pass
+
+    @abstractmethod
+    def pre_load(self, *args):
+        pass
+        

xtendr/xtendrsystem.py

@@ -2,9 +2,10 @@ import importlib
 import sys
 import os
 import json
+import threading
 from xtendr.xtendrbase import XtendRBase
 
-__version__ = "0.1.2"
+__version__ = "0.3.3.1"
 
 class XtendRSystem:
     """Plugin system to manage plugins.
@@ -12,7 +13,7 @@ class XtendRSystem:
     Example:
     >>> system = XtendRSystem()
     >>> system.version()
-    XtendR v0.1.2
+    XtendR v0.1.3
     >>> system.attach("example_plugin")  # Assuming 'example_plugin/example_plugin.json' exists
     >>> system.run("example_plugin")
     ExamplePlugin is running!
@@ -28,13 +29,13 @@ class XtendRSystem:
     def version(self) -> str:
         return "XtendR v" + __version__
     
-    def attach(self, name: str) -> None:
+    def attach(self, name: str, callback) -> None:
         """Dynamically load a plugin from its folder."""
         if name in self.plugins:
             print(f"Plugin '{name}' is already attached.")
             return
         
-        plugin_path = os.path.join(os.getcwd(), self.pluginpath, name)
+        plugin_path = os.path.join(os.getcwd(), self.pluginspath, name)
         info_path = os.path.join(plugin_path, name + ".json")
         print(plugin_path + "\n" + info_path)
         
@@ -67,6 +68,9 @@ class XtendRSystem:
                     'autorun': False
                 }
                 print(f"Attached plugin '{name}'.")
+                print(f"Running pre-load on '{name}'.")
+                thread = threading.Thread(target=self.plugins[name]['instance'].pre_load, args=(callback,))
+                thread.start()
         except (ModuleNotFoundError, json.JSONDecodeError, AttributeError) as e:
             print(f"Failed to attach plugin '{name}': {e}")