Changes between Initial Version and Version 1 of ComponentDependencyPlugin

Timestamp:

Jul 29, 2009, 8:46:08 PM (15 years ago)

Author:

Jeff Hammel

Comment:

New hack ComponentDependencyPlugin, created by k0s

ComponentDependencyPlugin

@@ +1 @@
+= 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 
+[report:9?COMPONENT=ComponentDependencyPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=ComponentDependencyPlugin&owner=k0s new ticket].
+
+== Download ==
+
+Download the zipped source from [download:componentdependencyplugin here].
+
+== Source ==
+
+You can check out ComponentDependencyPlugin from [http://trac-hacks.org/svn/componentdependencyplugin here] using Subversion, or [source:componentdependencyplugin 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 ==
+
+[[ChangeLog(componentdependencyplugin, 3)]]
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:k0s] [[BR]]
+'''Contributors:'''