wiki:ComponentDependencyPlugin

Version 2 (modified by k0s, 5 years ago) (diff)

--

allows components to state dependencies on other plugins

Description

ComponentDependencyPlugin allows a Component to state a dependency on other plugin, via the IRequireComponents interface:

class IRequireComponents(Interface):
    def requires():
        """list of component classes that this component depends on"""

The Component classes that are returned by the requires method will be enabled upon environment upgrade. This allows very simple dependencies. Of course, for installation, the required components are still required to be part of python (in install_requires in setup.py) and this plugin will not work if there is trouble loading a plugin that is required.

Bugs/Feature Requests

Existing bugs and feature requests for ComponentDependencyPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out ComponentDependencyPlugin from here using Subversion, or browse the source with Trac.

Example

The files in test.py illustrate how to use the plugin. Enable the ComponentDependencyPlugin (componentdependencies.componentdependency.componentdependencyplugin = enabled) and enable the TestDependencyPlugin (componentdependencies.test.testdependencyplugin = enabled). Trac will then require an upgrade. The FooBarTest component will be enabled in the upgrade.

Recent Changes

[6314] by k0s on 2009-07-29 22:47:58
initial import of ComponentDependencyPlugin
[6313] by k0s on 2009-07-29 22:47:08
remove erroneously created directory
[6312] by k0s on 2009-07-29 22:46:42
create the correct directory

Author/Contributors

Originally developed at The Open Planning Project

Author: k0s
Contributors: