summaryrefslogtreecommitdiff
path: root/python/pluginbase/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/pluginbase/README')
-rw-r--r--python/pluginbase/README15
1 files changed, 15 insertions, 0 deletions
diff --git a/python/pluginbase/README b/python/pluginbase/README
new file mode 100644
index 0000000000..0197dd88e4
--- /dev/null
+++ b/python/pluginbase/README
@@ -0,0 +1,15 @@
+PluginBase is a module for Python that enables the development of
+flexible plugin systems in Python.
+
+Step 1:
+ from pluginbase import PluginBase
+ plugin_base = PluginBase(package='yourapplication.plugins')
+
+Step 2:
+ plugin_source = plugin_base.make_plugin_source(
+ searchpath=['./path/to/plugins', './path/to/more/plugins'])
+
+Step 3:
+ with plugin_source:
+ from yourapplication.plugins import my_plugin
+ my_plugin.do_something_cool()