Merge branch 'master' of https://github.com/theintencity/rtclite

dialex-com · Jul 1, 2016 · 597564b · 597564b
2 parents ba679e1 + 28abc7c
commit 597564b
Showing 1 changed file with 63 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -46,11 +46,69 @@ the specification, (b) which part of the specification is relevant to the
 code fragment, and vice-versa, and (c) the implicit code documentation 
 borrowed from the text in the specification.
 
-[Browse annotated source code](http://kundansingh.com/p/rtclite/index.html),
-e.g., [rfc3550.py (RTP)](http://kundansingh.com/p/rtclite/std/ietf/rfc3550.py.html),
-[rfc3261.py (SIP)](http://kundansingh.com/p/rtclite/std/ietf/rfc3261.py.html),
-[caller.py](http://kundansingh.com/p/rtclite/app/sip/caller.py.html),
-[chat.py](http://kundansingh.com/p/rtclite/vnd/google/chat.py.html).
+[Click to browse the annotated source code](http://kundansingh.com/p/rtclite/index.html).
+
+Alternatively, click on individual modules below to view that annotated code and its Python source lines of code (SLoC). The SLoC also shows the concise nature of this Python implementation of various protocols and applications. 
+
+| Module | Package or Description | SLoC |
+|:------|:------|-----:|
+|| package: rtclite.std.ietf ||
+|[rfc1035](http://kundansingh.com/p/rtclite/std/ietf/rfc1035.py.html)| DNS lookup for any record type |1125|
+|[rfc2198](http://kundansingh.com/p/rtclite/std/ietf/rfc2198.py.html)| RTP payload type for redundant audio data |51|
+|[rfc2396](http://kundansingh.com/p/rtclite/std/ietf/rfc2396.py.html)| Various forms of addresses such as URI or SIP address |177|
+|[rfc2617](http://kundansingh.com/p/rtclite/std/ietf/rfc2617.py.html)| HTTP basic and digest authentication |92|
+|[rfc2833](http://kundansingh.com/p/rtclite/std/ietf/rfc2833.py.html)| DTMF touch-tone payload in RTP packet |48|
+|[rfc3261](http://kundansingh.com/p/rtclite/std/ietf/rfc3261.py.html)| **Session Initiation Protocol (SIP)** |1425|
+|[rfc3263](http://kundansingh.com/p/rtclite/std/ietf/rfc3263.py.html)| SIP server discovery using DNS NAPTR, SRC and A records |107|
+|[rfc3264](http://kundansingh.com/p/rtclite/std/ietf/rfc3264.py.html)| SDP offer-answer model for unicast session in SIP |97|
+|[rfc3489](http://kundansingh.com/p/rtclite/std/ietf/rfc3489.py.html)| Basic NAT traversal technologies such as STUN, NAT discovery using STUN and TURN |595|
+|[rfc3550](http://kundansingh.com/p/rtclite/std/ietf/rfc3550.py.html)| **Real-time Transport Protocol (RTP)** and companion control protocol RTCP |725|
+|[rfc3551](http://kundansingh.com/p/rtclite/std/ietf/rfc3551.py.html)| Static payload types for RTP |34|
+|[rfc3920](http://kundansingh.com/p/rtclite/std/ietf/rfc3920.py.html)| XMPP core for client side |351|
+|[rfc3921](http://kundansingh.com/p/rtclite/std/ietf/rfc3921.py.html)| IM and presence of XMPP client side |290|
+|[rfc4566](http://kundansingh.com/p/rtclite/std/ietf/rfc4566.py.html)| Session Description Protocol (SDP) |148|
+|[rfc5389](http://kundansingh.com/p/rtclite/std/ietf/rfc5389.py.html)| Session traversal utilities for NAT (STUN) |128|
+|[rfc6455](http://kundansingh.com/p/rtclite/std/ietf/rfc6455.py.html)| WebSocket protocol - client and server |565|
+|[rfc7064](http://kundansingh.com/p/rtclite/std/ietf/rfc7064.py.html)| URI scheme for STUN, patch rfc2396 |28|
+|[rfc7065](http://kundansingh.com/p/rtclite/std/ietf/rfc7065.py.html)| URI scheme for TURN, patch rfc2396 |41|
+|| package: rtclite.std.itu_t ||
+|[t140](http://kundansingh.com/p/rtclite/std/itu_t/t140.py.html)| real-time text (RTT) payload in RTP |13|
+|| package: rtclite.std.w3c ||
+|[simplexml](http://kundansingh.com/p/rtclite/std/w3c/simplexml.py.html)| Simple XML DOM with Pythonic convenient methods and operators for XML and XMLList |363|
+|| package: rtclite.app.sip ||
+|[client](http://kundansingh.com/p/rtclite/app/sip/client.py.html)| SIP user agent library for registration, call, IM, conferences |1258|
+|[server](http://kundansingh.com/p/rtclite/app/sip/server.py.html)| Very simple SIP registration, proxy server, including WebSocket  |100|
+|[caller](http://kundansingh.com/p/rtclite/app/sip/caller.py.html)| **command line SIP caller** and call listener with voice, TTS, ASR, DTMF |729|
+|[api](http://kundansingh.com/p/rtclite/app/sip/api.py.html)| SIP API for use in programmable servers and clients |371|
+|[p2p](http://kundansingh.com/p/rtclite/app/sip/p2p.py.html)| One way to implement P2P-SIP, not based on the IETF standard |315|
+|| package: rtclite.app.net.p2p ||
+|[dht](http://kundansingh.com/p/rtclite/app/net/p2p/dht.py.html)| Distributed Hash Table (DHT) inspired by BambooDHT and OpenDHT |1712|
+|[dhtgui](http://kundansingh.com/p/rtclite/app/net/p2p/dhtgui.py.html)| GUI to see P2P network in action |356|
+|[opendht](http://kundansingh.com/p/rtclite/app/net/p2p/opendht.py.html)| (defunct) Interface to connect to OpenDHT |63|
+|[pipe](http://kundansingh.com/p/rtclite/app/net/p2p/pipe.py.html)| P2P pipe abstraction |590|
+|| package: rtclite.app.sec ||
+|[crypto](http://kundansingh.com/p/rtclite/app/sec/crypto.py.html)| Crypto library wrapper, e.g., PKI, ASN1, ARC, etc. |251|
+|[dummycrypto](http://kundansingh.com/p/rtclite/app/sec/dummycrypto.py.html)| Stub for crypto module |24|
+|| package: rtclite.app.web.rest ||
+|[base](http://kundansingh.com/p/rtclite/app/web/rest/base.py.html)| Building blocks for creating REST APIs |196|
+|[data](http://kundansingh.com/p/rtclite/app/web/rest/data.py.html)| Expose structured data as REST resources |152|
+|[files](http://kundansingh.com/p/rtclite/app/web/rest/files.py.html)| Expose local file structure as REST resources |94|
+|| package: rtclite.app.web.rtc ||
+|[notify](http://kundansingh.com/p/rtclite/app/web/rtc/notify.py.html)| WebRTC notification server for signaling over WebSocket |198|
+|| package: rtclite.vnd.adobe ||
+|[rtmp](http://kundansingh.com/p/rtclite/vnd/adobe/rtmp.py.html)| **Real Time Messaging Protocol (RTMP)** parsing, formatting, server, and FLV |1068|
+|[rtmpclient](http://kundansingh.com/p/rtclite/vnd/adobe/rtmpclient.py.html)| command line RTMP client |345|
+|[rtmpt](http://kundansingh.com/p/rtclite/vnd/adobe/rtmpt.py.html)| RTMP tunneling |165|
+|[siprtmp](http://kundansingh.com/p/rtclite/vnd/adobe/siprtmp.py.html)| SIP-RTMP translation for voice and video |1147|
+|[aes](http://kundansingh.com/p/rtclite/vnd/adobe/aes.py.html)| Pure python based AES, used only when PyOpenSSL is not found |179|
+|[amf](http://kundansingh.com/p/rtclite/vnd/adobe/amf.py.html)| Action Message Format (AMF) 0 and 3 |367|
+|[rtmfp](http://kundansingh.com/p/rtclite/vnd/adobe/rtmfp.py.html)| Real-Time Media Flow Protocol (RTMFP) parsing and formatting |2095|
+|| package: rtclite.vnd.google ||
+|[chat](http://kundansingh.com/p/rtclite/vnd/google/chat.py.html)cht| **Send and receive Google Chat messages** over XMPP |60|
+|| package: rtclite ||
+|[common](http://kundansingh.com/p/rtclite/common.py.html)| Common utility methods and classes |410|
+|[multitask](http://kundansingh.com/p/rtclite/multitask.py.html)| Co-operative multitasking |469|
+
 
 Furthermore, the project contains various applications built on top of these
 open standards and open source implementations to demonstrate real use cases, e.g.,