WikiStart

Version 98 (Adrian Georgescu, 08/14/2008 01:36 pm)

1 1
[[Image(htdocs:SIPUA-design-50.png, align=right, link=wiki:SIPUADesign)]]
2 96 Ruud Klaver
3 96 Ruud Klaver
== Project description == 
4 95 Ruud Klaver
5 98 Adrian Georgescu
PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with a clever middleware allows for easy development of SIP User agents with [wiki:RichPresence rich presence]  capability that run on desktop computers running Mac OS X, Linux and Windows operating systems, portable Internet devices like Nokia 810, Apple iPhone or Android mobile phones.
6 1
7 14 Adrian Georgescu
== License == 
8 14 Adrian Georgescu
9 12 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
10 1
11 14 Adrian Georgescu
== Deliverables ==
12 1
13 40 Adrian Georgescu
The goal of this project is to deliver an Open Source development kit for a rich featured SIP User Agent while hiding the complex underlying functionality behind an easy to use high-level application programming interface. You may collapse the whole telecom industry into a simple ''Call me'' button or expand the presence buddy list to display the mood or blood pressure of your buddies (if they want to share this information with you).   
14 39 Adrian Georgescu
15 45 Adrian Georgescu
Using this software you are able to create elegant real-time communications applications without having to read or understand [http://www.rfc3261.net the +1200 RFC documents] behind it. 
16 45 Adrian Georgescu
17 47 Adrian Georgescu
''If you read them all some antidepressant and desintoxication is recommended after this effort.''
18 1
19 92 Ruud Klaver
== High level design ==
20 92 Ruud Klaver
21 92 Ruud Klaver
PyPjUA is part of a [wiki:SIPUADesign greater design] design to provide a fully fledged SIP UA. 
22 92 Ruud Klaver
23 34 Adrian Georgescu
== Software repository ==
24 34 Adrian Georgescu
25 88 Adrian Georgescu
Besides the Python software library itself, the repository contains the ready to use sip-simple-test-tools package that can be used to:
26 1
27 87 Adrian Georgescu
  * Setup SIP [http://tools.ietf.org/html/rfc4975 MSRP sessions] between end-points with public IP or behind NAT by using [http://tools.ietf.org/html/rfc4976 MSRP relay]
28 87 Adrian Georgescu
  * Setup up VoIP sessions between end-points with public IP adresses or behind NAT by using ICE and media relay
29 94 Adrian Georgescu
  * [http://www.ietf.org/rfc/rfc3903.txt PUBLISH] and [http://www.ietf.org/rfc/rfc3265.txt SUBSCRIBE/NOTIFY] to SIP events like [http://www.ietf.org/rfc/rfc3856.txt presence], [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], [http://www.ietf.org/rfc/rfc3857.txt watcher-info], conference, [http://www.ietf.org/rfc/rfc3842.txt message-summary]
30 1
  * Manage presence policy the form of full or partial [http://www.tools.ietf.org/html/rfc4825 XCAP] documents like [http://www.tools.ietf.org/html/rfc5025 pres-rules], [http://www.tools.ietf.org/html/rfc4826 resource-lists, rls-services] and [http://www.tools.ietf.org/html/rfc4827 pidf-manipulation]
31 85 Adrian Georgescu
  * Lookup of SIP buddies using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast), [http://www.ietf.org/rfc/rfc3263.txt RFC 3263] (Locating SIP Services), ENUM (E.164 telephone numbers) and DHT (structured P2P overlays)
32 90 Adrian Georgescu
  * Setup up [http://www.tech-invite.com/SIPWGs/03-WG-SIMPLE/Drafts/draft-ietf-simple-chat-02.txt ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)
33 1
34 97 Adrian Georgescu
Using these scripts is easy to prototype [wiki:RichPresence Rich Presence], IM and VoIP services based on the SIP protocol. 
35 86 Adrian Georgescu
To use these tools you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
36 34 Adrian Georgescu
37 34 Adrian Georgescu
== Download  == 
38 34 Adrian Georgescu
39 34 Adrian Georgescu
The software can be downloaded from:
40 34 Adrian Georgescu
41 34 Adrian Georgescu
[http://download.ag-projects.com/PyPjUA http://download.ag-projects.com/PyPjUA]
42 34 Adrian Georgescu
43 34 Adrian Georgescu
== End-user experiences ==
44 33 Adrian Georgescu
45 33 Adrian Georgescu
Using this toolkit you can develop in short time a skinable and cross-platform SIP User Agent that can be used for real-time Internet communications:
46 33 Adrian Georgescu
47 74 Adrian Georgescu
  * VoIP calls using Internet codecs (Speex, iLBC) and G.711
48 81 Adrian Georgescu
  * Multiple audio/msrp/video streams per session (for live broadcasting applications)
49 69 Adrian Georgescu
  * Zero configuration when communication over LAN (Bonjour)
50 71 Adrian Georgescu
  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
51 33 Adrian Georgescu
  * Interactive Messaging (IM) and File transfer using MSRP protocol
52 89 Adrian Georgescu
  * Multiparty chat using MSRP chat server (under construction)
53 33 Adrian Georgescu
  * Support for NAT traversal using ICE for RTP media and MSRP Relay for IM
54 91 Adrian Georgescu
  * Sharing desktop screen using VNC protocol (under construction)
55 89 Adrian Georgescu
  * Video calls (under construction)
56 1
57 93 Adrian Georgescu
As a library with a high-level API, the toolkit can also be used to add SIP and Presence functionality to network devices without a display (like TV set-up boxes), as long as Python environment is supported by such platform.
58 93 Adrian Georgescu
59 82 Adrian Georgescu
The software is tested against the most popular SIP server software: [http://openser.org OpenSER], [http://openxcap.org OpenXCAP], [http://mediaproxy-ng.org MediaProxy] and [http://msrprelay.org MSRPRelay] servers. To test the software you can register a free SIP SIMPLE account on [http://SIP2SIP.info SIP2SIP]
60 62 Adrian Georgescu
61 62 Adrian Georgescu
62 62 Adrian Georgescu
== Integration with third-party projects ==
63 62 Adrian Georgescu
64 80 Adrian Georgescu
PyPjUA will be first integrated into [http://tribler.org Tribler]. Tribler is an application that enables its users to find, enjoy and share content. With content we mean video, audio, pictures, and much more. PyPjUA will provides real-time communications features that will allow users that have downloaded Tribler to:
65 62 Adrian Georgescu
66 80 Adrian Georgescu
 * Interact in real time with each other using rich Presence, Interactive messaging and audio
67 70 Adrian Georgescu
 * Communicate with other people that have access to SIP services from various SIP operators across the world
68 12 Adrian Georgescu
69 17 Adrian Georgescu
== Developer program ==
70 17 Adrian Georgescu
71 32 Adrian Georgescu
To become an active developer to this program please send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com]
72 17 Adrian Georgescu
73 12 Adrian Georgescu
== Support == 
74 11 Adrian Georgescu
75 11 Adrian Georgescu
The software is developed and supported by [http://ag-projects.com AG Projects].