1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
## KAMCLI Development ##
Kamailio Command Line Interface Control Tool
### Development Environment ###
Use 4 spaces for indentation.
#### [pre-commit](https://pre-commit.com/) ####
It is highly recommended to set the `pre-commit` git hook to get code identation and
error detections using `black` and `flake8` tools before changes are committed.
On a Debian/Ubuntu system, do:
```
apt install build-essentials python3-dev python3-virtualenvwrapper
mkvirtualenv kamcli --python=python3
pip install -r requirements/requirements_dev.txt
pre-commit install
```
### Development Guidelines ###
#### Used Frameworks ####
Kamcli is using the following Python frameworks:
* click - command line interface framework
* http://click.pocoo.org
* SQL Alchemy - connection to database
* http://www.sqlalchemy.org
* pyaml - yaml package used for compact printing of jsonrpc responses
* tabulate - pretty printing of database results
#### Plugins ####
Kamcli prototype is:
```
kamcli <command> [params]
```
Each command is implemented as a plugin, its code residing in a single Python
file located in *kamcli/commands/*. The filename is prefixed by **cmd_**,
followed by command name and then the extension **.py**.
Development of kamcli has its starting point in the *complex* example of Click:
* https://github.com/mitsuhiko/click/tree/master/examples/complex
Other examples provided by Click are good source of inspiration:
* https://github.com/mitsuhiko/click/tree/master/examples
#### Adding A New Command ####
In short, the steps for adding a new command (refered also as plugin or module):
* create a new file file for your new comand in **kamcli/commands/** folder
* name the file **cmd_newcommand.py**
* define **cli(...)** function, which can be a command or group of commands
Once implemented, the new command should be immediately available as:
```
kamcli newcommand ...
```
The commands **dispatcher** (kamcli/commands/cmd_dispatcher.py) or **address**
(kamcli/commands/cmd_address.py) can be a good reference to look at and reuse
for implementing new commands.
If the new command is executing MI or JSONRPC commands to kamailio, add the
appropriate mapping inside the **kamcli/iorpc.py** file to the variable
**COMMAND_NAMES**. The recommendation is to use the RPC command as the common
name and then map the MI variant - MI is obsoleted and scheduled to be removed.
|
