Merge pull request '0.0.7' (#20) from 0.0.7 into main

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

Makefile

@@ -0,0 +1,8 @@
+dist:
+    python -m build
+
+test:
+    twine upload --repository testpypi /dist
+
+publish:
+    twine upload --repository pypi /dist

README.md

@@ -1,3 +1,30 @@
 # XtendR
 
-A python 3 extension system to ease the use of plugins.
+A very basic Python 3.12 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  
+:heavy_plus_sign: Work well with Python 3.12  
+:heavy_plus_sign: Maintainable - Don't expect to see new releases every month. __If it ain't broken, don't fix it!!!__
+
+I previously used yapsy, but it doesn't meet the requirements anymore.  
+:x: No longer simple, and simple to use (Simplicity in use has been sacrificed for more complexity. It has become bloated)  
+:x: Not workink with Python 3.12  
+:x: No longer maintained (Hasn't been maintained for a few years)
+
+I didn't find anything that suited my needs, so I decided to make my own plugin system.  
+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
+- Run
+- Stop
+- Detach
+
+Attach and Detach are used for registrering/unregistrering a module on the system.
+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.

example.py

@@ -1,4 +1,4 @@
-from xtendr.xtendr import XtendR
+from xtendr.xtendrsystem import XtendRSystem
 
 if __name__ == "__main__":
     """Example usage of the PluginSystem.
@@ -14,7 +14,7 @@ if __name__ == "__main__":
     >>> system.detach("example_plugin")
     Detached plugin 'example_plugin'.
     """
-    system = XtendR()
+    system = XtendRSystem()
     system.attach("example_plugin")  # Assuming 'example_plugin/plugin_info.json' exists
     system.run("example_plugin")
     system.stop("example_plugin")

plugins/example_plugin/example_plugin.json

@@ -2,5 +2,6 @@
     "name": "Example Plugin",
     "version": "1.0",
     "module": "example_plugin",
+    "class": "ExamplePlugin",
     "description": "An example plugin that prints a message."
 }

plugins/example_plugin/example_plugin.py

@@ -1,4 +1,4 @@
-from xtendr import XtendRBase
+from xtendr.xtendrbase import XtendRBase
 
 class ExamplePlugin(XtendRBase):
     """Example plugin implementation.

setup.py

@@ -3,17 +3,17 @@ if __name__ == "__main__":
     
     setup(
         name="XtendR",
-        version="0.0.1",
+        version="0.0.7",
         packages=find_packages(),
         install_requires=[],
         author="Jan Lerking",
         author_email="",
         description="A modular plugin system for Python.",
-        url="",
+        url="https://www.gitea.com/Lerking/XtendR",
         classifiers=[
-            "Programming Language :: Python :: 3.12",
+            "Programming Language :: Python :: 3.11",
             "License :: OSI Approved :: MIT License",
             "Operating System :: OS Independent",
         ],
-        python_requires='>=3.12',
+        python_requires='>=3.11',
     )

xtendr/__init__.py

@@ -1 +1,2 @@
-import xtendr
+from . import xtendrbase
+from . import xtendrsystem

xtendr/xtendrbase.py

@@ -0,0 +1,25 @@
+from abc import ABC, abstractmethod
+
+class XtendRBase(ABC):
+    """Abstract base class for all plugins.
+    
+    Example:
+    >>> class TestPlugin(XtendRBase):
+    ...     def run(self):
+    ...         print("Running TestPlugin")
+    ...     def stop(self):
+    ...         print("Stopping TestPlugin")
+    
+    >>> plugin = TestPlugin()
+    >>> plugin.run()
+    Running TestPlugin
+    >>> plugin.stop()
+    Stopping TestPlugin
+    """
+    @abstractmethod
+    def run(self):
+        pass
+    
+    @abstractmethod
+    def stop(self):
+        pass

xtendr/xtendrsystem.py

@@ -2,38 +2,14 @@ import importlib
 import sys
 import os
 import json
-from abc import ABC, abstractmethod
+from xtendr.xtendrbase import XtendRBase
 
-class XtendRBase(ABC):
-    """Abstract base class for all plugins.
-    
-    Example:
-    >>> class TestPlugin(XtendRBase):
-    ...     def run(self):
-    ...         print("Running TestPlugin")
-    ...     def stop(self):
-    ...         print("Stopping TestPlugin")
-    
-    >>> plugin = TestPlugin()
-    >>> plugin.run()
-    Running TestPlugin
-    >>> plugin.stop()
-    Stopping TestPlugin
-    """
-    @abstractmethod
-    def run(self):
-        pass
-    
-    @abstractmethod
-    def stop(self):
-        pass
-
-class XtendR:
+class XtendRSystem:
     """Plugin system to manage plugins.
     
     Example:
     >>> system = XtendRSystem()
-    >>> system.attach("example_plugin")  # Assuming 'example_plugin/plugin_info.json' exists
+    >>> system.attach("example_plugin")  # Assuming 'example_plugin/example_plugin.json' exists
     >>> system.run("example_plugin")
     ExamplePlugin is running!
     >>> system.stop("example_plugin")
@@ -50,8 +26,9 @@ class XtendR:
             print(f"Plugin '{name}' is already attached.")
             return
         
-        plugin_path = os.path.join(os.getcwd(), name)
-        info_path = os.path.join(plugin_path, "plugin_info.json")
+        plugin_path = os.path.join(os.getcwd(), "plugins", name)
+        info_path = os.path.join(plugin_path, name + ".json")
+        print(plugin_path + "\n" + info_path)
         
         if not os.path.isdir(plugin_path) or not os.path.isfile(info_path):
             print(f"Failed to attach plugin '{name}', folder or info file not found.")