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.

setup.py

@@ -3,17 +3,17 @@ if __name__ == "__main__":
     
     setup(
         name="XtendR",
-        version="0.0.3",
+        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/xtendrbase.py

@@ -1,7 +1,3 @@
-import importlib
-import sys
-import os
-import json
 from abc import ABC, abstractmethod
 
 class XtendRBase(ABC):

xtendr/xtendrsystem.py

@@ -2,7 +2,6 @@ import importlib
 import sys
 import os
 import json
-from abc import ABC, abstractmethod
 from xtendr.xtendrbase import XtendRBase
 
 class XtendRSystem:
@@ -10,7 +9,7 @@ class XtendRSystem:
     
     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")