{"id":16156436,"url":"https://github.com/benhoff/pluginmanager","last_synced_at":"2025-10-04T12:26:04.762Z","repository":{"id":57453660,"uuid":"42396331","full_name":"benhoff/pluginmanager","owner":"benhoff","description":"Python plugin management, simplified.","archived":false,"fork":false,"pushed_at":"2016-12-26T20:04:41.000Z","size":983,"stargazers_count":16,"open_issues_count":9,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-28T12:06:22.789Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benhoff.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-13T13:13:34.000Z","updated_at":"2023-09-06T04:06:15.000Z","dependencies_parsed_at":"2022-08-29T11:11:55.642Z","dependency_job_id":null,"html_url":"https://github.com/benhoff/pluginmanager","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoff%2Fpluginmanager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoff%2Fpluginmanager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoff%2Fpluginmanager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoff%2Fpluginmanager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benhoff","download_url":"https://codeload.github.com/benhoff/pluginmanager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243950792,"owners_count":20373664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T01:44:54.498Z","updated_at":"2025-10-04T12:25:59.721Z","avatar_url":"https://github.com/benhoff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. pluginmanager documentation master file, created by\n   sphinx-quickstart on Wed Dec  9 22:32:56 2015.\n   You can adapt this file completely to your liking, but it should at least\n   contain the root `toctree` directive.\n\n.. testsetup:: quickstart\n\n    import os\n    from pluginmanager.tests.compat import tempfile\n    tempdirectory = tempfile.TemporaryDirectory()\n    plugin_directory_path = tempdirectory.name\n    path = os.path.join(tempdirectory.name, 'test.py')\n    with open(path, 'w+') as f:\n        f.write('from pluginmanager import IPlugin\\nclass Test(IPlugin):\\n    pass')\n\npluginmanager\n=============\n|Build Status| |Coverage Status| |Code Climate|\n\npython plugin management, simplified.\n\n\n`Documentation \u003chttp://pluginmanager.readthedocs.org/en/latest/\u003e`_\n\n`Source Code \u003chttps://github.com/benhoff/pluginmanager\u003e`_\n\nLibrary under development. Contains rough edges/unfinished functionality. API subject to changes.\n\nInstallation\n------------\n\n::\n\n    pip install pluginmanager\n\n-or- ::\n\n    pip install git+https://github.com/benhoff/pluginmanager.git\n\nQuickstart\n----------\n\n::\n\n    from pluginmanager import PluginInterface\n\n    plugin_interface = PluginInterface()\n    plugin_interface.set_plugin_directories(plugin_directory_path)\n    plugin_interface.collect_plugins()\n\n    plugins = plugin_interface.get_instances()\n\n\nCustom Plugins\n--------------\n\nThe quickstart will only work if you subclass `IPlugin` for your custom plugins.\n\n::\n\n    import pluginmanager\n\n    class MyCustomPlugin(pluginmanager.IPlugin):\n        def __init__(self):\n            self.name = 'custom_name'\n            super().__init__()\n\nOr register your class as subclass of IPlugin.\n\n::\n\n    import pluginmanager\n\n    pluginmanager.IPlugin.register(YourClassHere)\n\nAdd Plugins Manually\n--------------------\nAdd classes.\n\n::\n\n    import pluginmanager\n\n    class CustomClass(pluginmanager.IPlugin):\n        pass\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_interface.add_plugins(CustomClass)\n\n    plugins = plugin_interface.get_instances()\n\n\nAlternatively, add instances.\n\n::\n\n    import pluginmanager\n\n    class CustomClass(pluginmanager.IPlugin):\n        pass\n\n    custom_class_instance = CustomClass()\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_interface.add_plugins(custom_class_instance)\n\n    plugins = plugin_interface.get_instances()\n\n\npluginmanager is defaulted to automatically instantiate unique instances. Disable automatic instantiation.\n\n::\n\n    import pluginmanager\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_manager = plugin_interface.plugin_manager\n\n    plugin_manager.instantiate_classes = False\n\nDisable uniqueness (Only one instance of class per pluginmanager)\n\n::\n\n    import pluginmanager\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_manager = plugin_interface.plugin_manager\n\n    plugin_manager.unique_instances = False\n\nFilter Instances\n----------------\n\nPass in a class to get back just the instances of a class\n\n::\n\n    import pluginmanager\n\n    class MyPluginClass(pluginmanager.IPlugin):\n        pass\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_interface.add_plugins(MyPluginClass)\n\n    all_instances_of_class = plugin_interface.get_instances(MyPluginClass)\n\n\nAlternatively, create and pass in your own custom filters. Either make a class based filter\n\n::\n\n    # create a custom plugin class\n    class Plugin(pluginmanager.IPlugin):\n        def __init__(self, name):\n            self.name = name\n\n    # create a custom filter\n    class NameFilter(object):\n        def __init__(self, name):\n            self.stored_name = name \n\n        def __call__(self, plugins):\n            result = []\n            for plugin in plugins:\n                if plugin.name == self.stored_name:\n                    result.append(plugin)\n            return result\n\n    # create an instance of our custom filter\n    mypluginclass_name_filter = NameFilter('good plugin')\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_interface.add_plugins([Plugin('good plugin'), \n                                  Plugin('bad plugin')])\n\n    filtered_plugins = plugin_interface.get_instances(mypluginclass_name_filter)\n\n\nOr make a function based filter\n\n::\n\n    # create a custom plugin class\n    class Plugin(pluginmanager.IPlugin):\n        def __init__(self, name):\n            self.name = name\n\n    # create a function based filter\n    def custom_filter(plugins):\n        result = []\n        for plugin in plugins:\n            if plugin.name == 'good plugin':\n                result.append(plugin)\n        return result\n\n    plugin_interface = pluginmanager.PluginInterface()\n    plugin_interface.add_plugins([Plugin('good plugin'), \n                                  Plugin('bad plugin')])\n\n    filtered_plugins = plugin_interface.get_instances(mypluginclass_name_filter)\n\n\nClass Overview\n--------------\n\n.. currentmodule:: pluginmanager\n.. autosummary::\n     :toctree: stubs\n\n     DirectoryManager\n     FileManager\n     ModuleManager\n     PluginManager\n     PluginInterface\n\n\nIndices and tables\n==================\n\n* :ref:`genindex`\n* :ref:`modindex`\n* :ref:`search`\n\n.. |Build Status| image:: https://travis-ci.org/benhoff/pluginmanager.svg?branch=master\n    :target: https://travis-ci.org/benhoff/pluginmanager\n.. |Coverage Status| image:: https://coveralls.io/repos/benhoff/pluginmanager/badge.svg?branch=master\u0026service=github\n    :target: https://coveralls.io/github/benhoff/pluginmanager?branch=master\n.. |Code Climate| image:: https://codeclimate.com/github/benhoff/pluginmanager/badges/gpa.svg\n    :target: https://codeclimate.com/github/benhoff/pluginmanager\n\n    \n\n.. testcleanup::\n    tempdirectory.cleanup()\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenhoff%2Fpluginmanager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenhoff%2Fpluginmanager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenhoff%2Fpluginmanager/lists"}