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.1.tar.gz (3.7 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for annex-0.1.tar.gz
Algorithm Hash digest
SHA256 20a2903fa3830a01a51d6358f5b276a53ed5697d1c9042f45e7cbed5cd8605ed
MD5 1cf27a01ed43d655a261b9396181a65b
BLAKE2b-256 b9dad55d73e6463f3e47cb1192a38518faa7d914902c8ef02ca19a6aab386a19

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