Revision 329753ae docs/setup.rst
| b/docs/setup.rst | ||
|---|---|---|
| 20 | 20 |
* Can be switched on/off in kamaki configuration file: colors=on/off |
| 21 | 21 |
* Installation: pip install ansicolors |
| 22 | 22 |
|
| 23 |
* progressbar
|
|
| 24 |
* Attach progressbars to various kamaki commands (e.g. kamaki store upload) |
|
| 23 |
* progress
|
|
| 24 |
* Attach progress bars to various kamaki commands (e.g. kamaki store upload)
|
|
| 25 | 25 |
* Installation: pip install progressbar |
| 26 |
* Since version 0.6.1 kamaki "requires" progress version 1.0.2 or better |
|
| 26 | 27 |
|
| 27 | 28 |
Any of the above features can be installed at any time before or after kamaki installation. |
| 28 | 29 |
|
| ... | ... | |
| 51 | 52 |
|
| 52 | 53 |
*kamaki store list -o global.account=anotheraccount -o global.token=aT0k3n==* |
| 53 | 54 |
|
| 54 |
will call *kamaki store list* with the specified options, but the initial global.account and global.token values will be restored afterwards.
|
|
| 55 |
will invoke *kamaki store list* with the specified options, but the initial global.account and global.token values will be restored to initial values afterwards.
|
|
| 55 | 56 |
|
| 56 | 57 |
Editing options |
| 57 | 58 |
^^^^^^^^^^^^^^^ |
| ... | ... | |
| 67 | 68 |
* kamaki config set <group.option> <value> |
| 68 | 69 |
set the group.option to value |
| 69 | 70 |
|
| 70 |
*kamaki config delete <group.option> |
|
| 71 |
* kamaki config delete <group.option>
|
|
| 71 | 72 |
delete a configuration option |
| 72 | 73 |
|
| 73 | 74 |
The above commands cause option values to be permanently stored in the Kamaki configuration file. |
| ... | ... | |
| 75 | 76 |
Editing the configuration file |
| 76 | 77 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 77 | 78 |
|
| 78 |
The configuration file is a simple text file that can be created by the user.d
|
|
| 79 |
The configuration file is a simple text file that can be created by the user. |
|
| 79 | 80 |
|
| 80 | 81 |
A simple way to create the configuration file is to set a configuration option using the kamaki config command. For example: |
| 81 | 82 |
|
| ... | ... | |
| 94 | 95 |
Available options |
| 95 | 96 |
^^^^^^^^^^^^^^^^^ |
| 96 | 97 |
|
| 97 |
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options like account, token, or url. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
|
|
| 98 |
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options, namely account, token, url, cli. This feature does not work for types of configuration options. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
|
|
| 98 | 99 |
|
| 99 | 100 |
* global.colors <on|off> |
| 100 | 101 |
enable/disable colors in command line based uis. Requires ansicolors, otherwise it is ignored |
| ... | ... | |
| 135 | 136 |
the url of the Astakos authentication service. Set to the Okeanos.grnet.gr Astakos service by default. Users should set a different value if they need to use a different service. |
| 136 | 137 |
|
| 137 | 138 |
* astakos.cli <UI command specifications for Astakos authentication service> |
| 138 |
a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing. |
|
| 139 |
a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing. |
|
| 140 |
|
|
| 141 |
Hidden features |
|
| 142 |
^^^^^^^^^^^^^^^ |
|
| 143 |
|
|
| 144 |
Since version 0.6.1 kamaki contains a test suite for the kamaki.clients API. The test suite can be activated with the following option on the configuration file: |
|
| 145 |
|
|
| 146 |
[test] |
|
| 147 |
cli=test_cli |
|
| 148 |
|
|
| 149 |
After that, users can run "kamaki test" commands to unittest the prepackaged client APIs. Unittests are still experimental and there is a high probability of false alarms due to some of the expected values being hard-coded in the testing code. |
|
Also available in: Unified diff