Skip to main content

A Simple Plugin System for Python

Project description

Summary

Annex provides assistance with developing plugin-based tools.

With Annex you can load and reload plugins from various python modules without the requirement that they exist on the PYTHONPATH.

Example Usage

In your project you would define a base class from which all plugins for project would subclass.

base_plugin.py

class BaseTestPlugin(object):
    def run(self, *args, **kwargs):
        raise NotImplementedError()

example_plugin.py

from base_plugin import BaseTestPlugin

class PrinterPlugin(BaseTestPlugin):
    def run(self, *args, **kwargs):
        print args, kwargs

foo.py

from base_plugin import BaseTestPlugin
from annex import Annex

plugins = Annex(BaseTestPlugin, ["/path/to/plugins"])

for plugin in plugins:
    plugin.run("foo", bar="baz")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

annex-0.4.0.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file annex-0.4.0.tar.gz.

File metadata

  • Download URL: annex-0.4.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for annex-0.4.0.tar.gz
Algorithm Hash digest
SHA256 c9d96008fd4891f339b7de11271899d95519516f5509aef27150e1d07961688b
MD5 a03ef93e7e55d372d080873f868a36e4
BLAKE2b-256 637fb92c1c58ad7d39dd2ccab58eef475b980987bce48d7f549c27e052df52fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page