YunoHost/moulinette
1
0
Fork 0
mirror of https://github.com/YunoHost/moulinette.git synced 2024-09-03 20:06:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Alexis Gavoty 2012-10-14 23:05:15 +03:00
parent 25dcad7cee
commit 8c506be3f9
1 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -5,6 +5,7 @@ YunoHost CLI
Specifications
--------------
### User
yunohost user list [-h] [--fields FIELDS [FIELDS ...]] [-o OFFSET]
@ -74,6 +75,19 @@ Specifications
Contribute
----------
Only few functions are implemented yet. If you want to contribute, just pick one action above (i.e. 'yunohost app addaccess') and make the function (here 'app_addaccess()') into the right file (here 'yunohost_app.py').
If you need LDAP connections or openned configuration files, take a look at the connection documentation in the 'parse_args' file.
If you need LDAP connections or openned configuration files, take a look at the connection documentation in the 'yunohost.py' file.
Dev self-notes
--------------
* A big dictionary of categories/actions/arguments is translated to parsers and subparsers with argument handling (argparse python library)
* One single action function is called after the parsing, named like 'category_action()'
* Connection to LDAP and/or config file openning is made before the action function
* Parsed arguments and connection dictionary are the only parameters passed to the action function
category_<action>(args, connections)
* 'connections' is optionnal
* Connections are closed just before the sys.exit calling