|
@@ -1,2 +1,20 @@
|
|
1
|
+## @package plugins Lodel2 plugin system
|
|
2
|
+#
|
|
3
|
+# The plugins activation system is based on <code>__init__.py</code> file.
|
|
4
|
+# The <code>__all__</code> variable in @ref plugins/__init__.py is generated
|
|
5
|
+# from configuration by Lodel.plugins._all_plugins() method. Then the plugins should
|
|
6
|
+# auto-import all its source files using it's own package <code>__init__.py</code> file
|
|
7
|
+#
|
|
8
|
+# For the moment plugins capabilities are :
|
|
9
|
+# - Hooks registration using Lodel.LodelHook decoration class
|
|
10
|
+# - User authentification methods registration using Lodel.user.authentication_method decorator
|
|
11
|
+# - User identification methods using Lodel.user.identification_method decorator
|
|
12
|
+#
|
|
13
|
+# You can find examples plugins in :
|
|
14
|
+# - plugins.dummy (Hooks registration)
|
|
15
|
+# - plugins.dummy_auth (Auth and identification methods registration)
|
|
16
|
+# - plugins.dummy_acl (Complex plugin with settings enhancement example)
|
|
17
|
+#
|
1
|
18
|
import Lodel.plugins
|
|
19
|
+## @brief Contain all activated plugins name
|
2
|
20
|
__all__ = Lodel.plugins._all_plugins()
|