From 0c8108d4d88b5c2b51797e143897b80132326f64 Mon Sep 17 00:00:00 2001 From: Jan Lerking Date: Sat, 29 Mar 2025 14:58:49 +0100 Subject: [PATCH] Updated project description. /JL --- README.md | 4 ++-- requirements.txt | 1 + setup.py | 9 +++++++-- xtendr/xtendrsystem.py | 2 +- 4 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index fd36701..fd31ebe 100644 --- a/README.md +++ b/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 @@ -28,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. \ No newline at end of file +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. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..2d14540 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +setuptools==68.2.2 diff --git a/setup.py b/setup.py index a07cced..35b566a 100644 --- a/setup.py +++ b/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.3.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' ) \ No newline at end of file diff --git a/xtendr/xtendrsystem.py b/xtendr/xtendrsystem.py index e01cef4..5db9627 100644 --- a/xtendr/xtendrsystem.py +++ b/xtendr/xtendrsystem.py @@ -5,7 +5,7 @@ import json import threading from xtendr.xtendrbase import XtendRBase -__version__ = "0.3.2" +__version__ = "0.3.3.1" class XtendRSystem: """Plugin system to manage plugins.