Added an example to the repo.

6 files changed, 131 insertions, 0 deletions

diff --git a/example/README b/example/README
new file mode 100644
index 0000000..6a275ca
--- /dev/null
+++ b/example/README
@@ -0,0 +1,16 @@
+
+  { pluginbase example }
+
+    A simple example that shows how plugin systems can be
+    built with pluginbase.
+
+    How to use:
+
+      1. Make sure pluginbase is installed:
+
+         pip install --editable ..
+
+      2. Run the example:
+
+         python example.py
+
diff --git a/example/app1/plugins/secret.py b/example/app1/plugins/secret.py
new file mode 100644
index 0000000..818aa67
--- /dev/null
+++ b/example/app1/plugins/secret.py
@@ -0,0 +1,13 @@
+import string
+
+
+def make_secret(s):
+    chars = list(s)
+    for idx, char in enumerate(chars):
+        if char not in string.punctuation and not char.isspace():
+            chars[idx] = 'x'
+    return ''.join(chars)
+
+
+def setup(app):
+    app.register_formatter('secret', make_secret)
diff --git a/example/app2/plugins/random.py b/example/app2/plugins/random.py
new file mode 100644
index 0000000..ed4c159
--- /dev/null
+++ b/example/app2/plugins/random.py
@@ -0,0 +1,14 @@
+import random
+import string
+
+
+def make_random(s):
+    chars = list(s)
+    for idx, char in enumerate(chars):
+        if char not in string.punctuation and not char.isspace():
+            chars[idx] = random.choice(string.ascii_letters)
+    return ''.join(chars)
+
+
+def setup(app):
+    app.register_formatter('random', make_random)
diff --git a/example/builtin_plugins/lowercase.py b/example/builtin_plugins/lowercase.py
new file mode 100644
index 0000000..0b5e1e9
--- /dev/null
+++ b/example/builtin_plugins/lowercase.py
@@ -0,0 +1,6 @@
+def make_lowercase(s):
+    return s.lower()
+
+
+def setup(app):
+    app.register_formatter('lowercase', make_lowercase)
diff --git a/example/builtin_plugins/uppercase.py b/example/builtin_plugins/uppercase.py
new file mode 100644
index 0000000..c055caf
--- /dev/null
+++ b/example/builtin_plugins/uppercase.py
@@ -0,0 +1,6 @@
+def make_uppercase(s):
+    return s.upper()
+
+
+def setup(app):
+    app.register_formatter('uppercase', make_uppercase)
diff --git a/example/example.py b/example/example.py
new file mode 100644
index 0000000..8d46943
--- /dev/null
+++ b/example/example.py
@@ -0,0 +1,76 @@
+import os
+from functools import partial
+from pluginbase import PluginBase
+
+
+# For easier usage calculate the path relative to here.
+here = os.path.abspath(os.path.dirname(__file__))
+get_path = partial(os.path.join, here)
+
+
+# Setup a plugin base for "example.modules" and make sure to load
+# all the default built-in plugins from the builtin_plugins folder.
+plugin_base = PluginBase(package='example.plugins',
+                         searchpath=[get_path('./builtin_plugins')])
+
+
+class Application(object):
+    """Represents a simple example application."""
+
+    def __init__(self, name):
+        # Each application has a name
+        self.name = name
+
+        # And a dictionary where it stores "formatters".  These will be
+        # functions provided by plugins which format strings.
+        self.formatters = {}
+
+        # and a source which loads the plugins from the "app_name/plugins"
+        # folder.
+        self.source = plugin_base.make_plugin_source(
+            searchpath=[get_path('./%s/plugins' % name)])
+
+        # Here we list all the plugins the source knows about, load them
+        # and the use the "setup" function provided by the plugin to
+        # initialize the plugin.
+        for plugin_name in self.source.list_plugins():
+            plugin = self.source.load_plugin(plugin_name)
+            plugin.setup(self)
+
+    def register_formatter(self, name, formatter):
+        """A function a plugin can use to register a formatter."""
+        self.formatters[name] = formatter
+
+
+def run_demo(app, source):
+    """Shows all formatters in demo mode of an application."""
+    print('Formatters for %s:' % app.name)
+    print('       input: %s' % source)
+    for name, fmt in sorted(app.formatters.items()):
+        print('  %10s: %s' % (name, fmt(source)))
+    print('')
+
+
+def main():
+    # This is the demo string we want to format.
+    source = 'This is a cool demo text to show this functionality.'
+
+    # Set up two applications.  One loads plugins from ./app1/plugins
+    # and the second one from ./app2/plugins.  Both will also load
+    # the default ./builtin_plugins.
+    app1 = Application('app1')
+    app2 = Application('app2')
+
+    # Run the demo for both
+    run_demo(app1, source)
+    run_demo(app2, source)
+
+    # And just to show how the import system works, we also showcase
+    # importing plugins regularly:
+    with app1.source:
+        from example.plugins import secret
+        print('Plugin module: %s' % secret)
+
+
+if __name__ == '__main__':
+    main()