Browse Source

Renamed acl plugin into dummy_acl + documentation update

Yann Weber 9 years ago
parent
commit
1ac0df3068
5 changed files with 30 additions and 0 deletions
  1. 12
    0
      README.md
  2. 18
    0
      plugins/__init__.py
  3. 0
    0
      plugins/dummy_acl/__init__.py
  4. 0
    0
      plugins/dummy_acl/acl.py
  5. 0
    0
      plugins/dummy_acl/conf.py

+ 12
- 0
README.md View File

@@ -27,6 +27,18 @@ If you want to write a script that run is the instance env you have to use
27 27
 
28 28
 -----
29 29
 
30
+Lodel2 plugins system:
31
+
32
+In an instance or in the lib dir you can ask Lodel2 wich plugins and wich hooks are activated.
33
+Print a list of plugins :
34
+	python3 manage_lodel.py --list-plugins
35
+Print a list of registered hooks :
36
+	python3 manage_lodel.py --list-hooks
37
+More informations about the script :
38
+	python3 manage_lodel.py --help
39
+
40
+-----
41
+
30 42
 ** Doxygen generation
31 43
   Dependencies : doxygen graphviz doxypy
32 44
   Generation : run make doc in the root folder

+ 18
- 0
plugins/__init__.py View File

@@ -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()

plugins/acl/__init__.py → plugins/dummy_acl/__init__.py View File


plugins/acl/acl.py → plugins/dummy_acl/acl.py View File


plugins/acl/conf.py → plugins/dummy_acl/conf.py View File


Loading…
Cancel
Save