Commit 59cadffb authored by Stavros Sachtouris's avatar Stavros Sachtouris

Suit up for release

parent be4eb3fa
......@@ -85,9 +85,9 @@ Kamaki interfaces make use of this CommandTree structure. Optimizations are poss
def command(cmd_tree, prefix='', descedants_depth=None):
"""Load a class as a command
@cmd_tree is the CommandTree to be updated with a new command
@prefix of the commands allowed to be inserted ('' for all)
@descedants_depth is the depth of the tree descedants of the
:param cmd_tree: is the CommandTree to be updated with a new command
:param prefix: of the commands allowed to be inserted ('' for all)
:param descedants_depth: is the depth of the tree descedants of the
prefix command.
"""
......@@ -125,7 +125,7 @@ The description of each command is the first line of the class commend. The foll
Declare run-time argument
-------------------------
The argument mechanism allows the definition of run-time arguments. Some basic argument types are defined at the `argument module <cli.html#module-kamaki.cli.argument>`_, but it is not uncommon to extent these classes in order to achieve specialized type checking and syntax control (e.g. at `pithos_cli module <cli.html#module-kamaki.cli.commands.pithos_cli>`_).
The argument mechanism allows the definition of run-time arguments. Some basic argument types are defined at the `argument module <code.html#module-kamaki.cli.argument>`_, but it is not uncommon to extent these classes in order to achieve specialized type checking and syntax control (e.g. at `pithos_cli module <code.html#module-kamaki.cli.commands.pithos_cli>`_).
To declare a run-time argument on a specific command, the object class should initialize a dict called *arguments* , where Argument objects are stored. Each argument object is a possible run-time argument. Syntax checking happens at client level, while the type checking is implemented in the Argument code (thus, many different Argument types might be needed).
......@@ -138,7 +138,7 @@ To declare a run-time argument on a specific command, the object class should in
class mygrp1_list_details():
"""list of details"""
def __init__(self, global_args={})
def __init__(self, global_args={}):
global_args['match'] = ValueArgument(
'Filter results to match string',
'--match')
......@@ -149,8 +149,8 @@ The main method and command parameters
The command behavior for each command / class is coded in *main*. The parameters of *main* method defines the command parameters part of the syntax. In specific::
main(self, param) - obligatory parameter
main(self, param=None) - optional parameter
main(self, param) - obligatory parameter <param>
main(self, param=None) - optional parameter [param]
main(self, param1, param2=42) - <param1> [param2]
main(self, param1____param2) - <param1:param2>
main(self, param1____param2=[]) - [param1:param2]
......
......@@ -8,10 +8,9 @@ Kamaki project documentation
.. image:: /images/kamaki-logo.png
./kamaki is a simple, yet intuitive, multipurpose command-line tool and client API for managing clouds.
./kamaki is a simple, yet intuitive, multipurpose, interactive command-line tool and client API for managing clouds.
It is an initial implementation of the OpenStack Compute API, v1.1, with custom
extensions specific to the Synnefo IaaS cloud management software.
As a develpment API is an initial implementation of the OpenStack Compute API, v1.1, with custom extensions specific to the `Synnefo IaaS <http://synnefo.org/>`_ cloud management software.
./kamaki is open source and released under a 2-clause BSD License.
......
......@@ -689,18 +689,18 @@ Kamaki shell features the ability to execute OS-shell commands from any context.
[kamaki]:!ls -al
total 16
drwxrwxr-x 2 saxtouri saxtouri 4096 Nov 27 16:47 .
drwxrwxr-x 7 saxtouri saxtouri 4096 Nov 27 16:47 ..
-rw-rw-r-- 1 saxtouri saxtouri 8063 Jun 28 14:48 kamaki-logo.png
drwxrwxr-x 2 username username 4096 Nov 27 16:47 .
drwxrwxr-x 7 username username 4096 Nov 27 16:47 ..
-rw-rw-r-- 1 username username 8063 Jun 28 14:48 kamaki-logo.png
[kamaki]:shell cp kamaki-logo.png logo-copy.png
[kamaki]:shell ls -al
total 24
drwxrwxr-x 2 saxtouri saxtouri 4096 Nov 27 16:47 .
drwxrwxr-x 7 saxtouri saxtouri 4096 Nov 27 16:47 ..
-rw-rw-r-- 1 saxtouri saxtouri 8063 Jun 28 14:48 kamaki-logo.png
-rw-rw-r-- 1 saxtouri saxtouri 8063 Jun 28 14:48 logo-copy.png
drwxrwxr-x 2 username username 4096 Nov 27 16:47 .
drwxrwxr-x 7 username username 4096 Nov 27 16:47 ..
-rw-rw-r-- 1 username username 8063 Jun 28 14:48 kamaki-logo.png
-rw-rw-r-- 1 username username 8063 Jun 28 14:48 logo-copy.png
Kamaki shell commits command strings to the outside shell and prints the results, without interacting with it. After a command is finished, kamaki shell returns to its initial state, which involves the current directory, as show in example 4.8.2 .
......
......@@ -31,4 +31,4 @@
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
__version__ = '0.6.1'
__version__ = '0.6.2'
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment