https://github.com/mitsuhiko/pluginbase

A simple but flexible plugin system for Python.
https://github.com/mitsuhiko/pluginbase

Last synced: 2 days ago
JSON representation

A simple but flexible plugin system for Python.

• Host: GitHub
• URL: https://github.com/mitsuhiko/pluginbase
• Owner: mitsuhiko
• License: other
• Created: 2014-06-30T20:51:42.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-05-16T16:23:31.000Z (over 3 years ago)
• Last Synced: 2025-01-16T19:18:15.458Z (9 days ago)
• Language: Python
• Size: 76.2 KB
• Stars: 1,126
• Watchers: 43
• Forks: 143
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - pluginbase - A simple but flexible plugin system for Python. (Python)
• jimsghstars - mitsuhiko/pluginbase - A simple but flexible plugin system for Python. (Python)

README

        
PluginBase

==========

PluginBase is a module for Python that enables the development of flexible plugin systems in Python.

Step 1:

.. code-block:: python

   from pluginbase import PluginBase

   plugin_base = PluginBase(package='yourapplication.plugins')

Step 2:

.. code-block:: python

   plugin_source = plugin_base.make_plugin_source(

       searchpath=['./path/to/plugins', './path/to/more/plugins'])

Step 3:

.. code-block:: python

   with plugin_source:

       from yourapplication.plugins import my_plugin

   my_plugin.do_something_cool()

Or alternatively:

.. code-block:: python

   my_plugin = plugin_source.load_plugin('my_plugin')

   my_plugin.do_something_cool()