[SR-Users] Kamailio KEMI Framework Tutorial

[Samuel F.]

Hi Daniel,


First, I'd just like to say thanks and let you know we are very grateful for the KEMI framework. We have developed three small applications running on python KEMI in production serving calls every day successfully without any issues at all. The development process was very smooth and quick.


I reviewed the documentation and think it's great that the KEMI framework gets an extensive documentation.


One thought I had regarding documenting the exported functions is that I think it's good if they are exported to the docs automatically from the source code. My opinion is that it is better to have documentation that reflects the current state of the source code rather than having stale/out-of-date documentation.


Perhaps having a parser that locates all the exported functions, lists them in appropriate modules with the return value and then a link to the actual modules documentation?


// Samuel

________________________________
From: sr-users <sr-users-bounces at lists.kamailio.org> on behalf of Daniel-Constantin Mierla <miconda at gmail.com>
Sent: Monday, November 20, 2017 4:11:54 PM
To: Kamailio (SER) - Users Mailing List; Kamailio (SER) - Devel Mailing List
Subject: [SR-Users] Kamailio KEMI Framework Tutorial

Hello,

I started a tutorial for Kamailio KEMI Framework written in markdown
format targeting use of mkdocs. It is published on github as part of
kamailio-docs repository:

  *
https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fkamailio%2Fkamailio-docs%2Ftree%2Fmaster%2Fkamailio-kemi-framework&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=MuTy1ZgjcDEbQdHTGA2LpO1sKUDAxxo%2BupwGr%2BBspCE%3D&reserved=0

The mkdocs build (to browse and read) is online at:

  * https://nam02.safelinks.protection.outlook.com/?url=http%3A%2F%2Fkamailio.org%2Fdocs%2Ftutorials%2Fdevel%2Fkamailio-kemi-framework%2F&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=FHJ1zANtLQI6o2%2F1wFPFYfu1B94JlQ%2FHTLDbaVp7dUg%3D&reserved=0

It is work in progress and contributions from the community are more
than welcome -- doing push requests on github project is the recommended
way for contributions:

  * https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fkamailio%2Fkamailio-docs%2F&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=utRI9tOvpEuyBWFU70KaBaod6URNk0ju4rTSQl%2FhO3I%3D&reserved=0

The main goal is document the role of KEMI, its benefits and how it can
be used. It addition it should cover the list of functions exported to
KEMI by core as well as special KEMI functions.

Regarding the functions exported by kamailio modules to KEMI I added as
an skeleton the ones exported by acc module. However, I am not sure if
we should do it there or add them to the existing docs of the modules.
Opinions on this?!?

Cheers,
Daniel

--
Daniel-Constantin Mierla
https://nam02.safelinks.protection.outlook.com/?url=www.twitter.com%2Fmiconda&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=%2F1Fg1476daehbTE4jVNmQ1%2BQro52j%2Fy6maGN8HZmHjU%3D&reserved=0 -- https://nam02.safelinks.protection.outlook.com/?url=www.linkedin.com%2Fin%2Fmiconda&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=WytUIkS%2FT0cdu%2BEMhSLz8TFhkn2PADOVGEjnHF5d2lE%3D&reserved=0
Kamailio Advanced Training - https://nam02.safelinks.protection.outlook.com/?url=www.asipto.com&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=b8D9EWNFf5eocdwbjZDu8nKmFF777nNE5yknicVgDKs%3D&reserved=0
Kamailio World Conference - May 14-16, 2018 - https://nam02.safelinks.protection.outlook.com/?url=www.kamailioworld.com&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=X7KEbj5w3kLSiCPrpgnrdoCITpeBiWPfAeYFyY2yMhk%3D&reserved=0


_______________________________________________
Kamailio (SER) - Users Mailing List
sr-users at lists.kamailio.org
https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.kamailio.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fsr-users&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=HLJ5knbTzvZ2EFRpdNEPawUUy5ArJVL6HVqitepIM2Q%3D&reserved=0
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.kamailio.org/pipermail/sr-users/attachments/20171121/e2c8b2bc/attachment.html>