WikiStart

Version 169 (Adrian Georgescu, 09/16/2008 10:38 pm)

1 133 Adrian Georgescu
[[Image(htdocs:SIPUA-design-70.png, align=right, link=wiki:SIPUADesign)]]
2 96 Ruud Klaver
3 96 Ruud Klaver
== Project description == 
4 95 Ruud Klaver
5 165 Adrian Georgescu
PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with an elegant middleware allows for easy development of real-time Internet communications end-points based on [http://tools.ietf.org/html/rfc3261 SIP protocol] with rich presence and IM capability for computers running Mac OS X, Linux and Windows operating systems or portable devices like Nokia Internet tablet, Apple iPhone and Android mobile phone.
6 1
7 14 Adrian Georgescu
== Deliverables ==
8 1
9 168 Adrian Georgescu
The goal of this project is to deliver the best Open Source development kit
10 168 Adrian Georgescu
for rich featured SIP User Agents, while hiding the complex underlying
11 168 Adrian Georgescu
functionality behind an easy to use high-level application programming
12 168 Adrian Georgescu
interface. Compared to other available SIP libraries, this project provides
13 168 Adrian Georgescu
session based Interactive Messaging (IM) using MSRP protocol, multiple
14 168 Adrian Georgescu
streams support, 'the missing' SIP-SIMPLE features for rich presence
15 168 Adrian Georgescu
(presence rules, resource lists, RLS services, RPIDF and XCAP policy).
16 168 Adrian Georgescu
17 47 Adrian Georgescu
18 169 Adrian Georgescu
The software library is tested against the most popular SIP server software available today: [http://opensips.org OpenSER], [http://asterisk.org Asterisk], [http://openxcap.org OpenXCAP], [http://msrprelay.org MSRPRelay] and [http://mediaproxy-ng.org MediaProxy]. 
19 138 Adrian Georgescu
20 123 Adrian Georgescu
== Download  == 
21 123 Adrian Georgescu
22 140 Adrian Georgescu
The software library and command line tools will be available for download on 2008 Q4 from: 
23 123 Adrian Georgescu
24 140 Adrian Georgescu
[http://download.ag-projects.com/PyPjUA http://download.ag-projects.com/PyPjUA]
25 123 Adrian Georgescu
26 111 Adrian Georgescu
== End-user experiences ==
27 1
28 156 Adrian Georgescu
This software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. 
29 1
30 157 Adrian Georgescu
''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 
31 123 Adrian Georgescu
32 123 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. 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). Some of the things possible with this library are listed here:
33 123 Adrian Georgescu
34 147 Adrian Georgescu
  * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711
35 1
  * Zero configuration server-less communication over LAN (Bonjour)
36 169 Adrian Georgescu
  * Parallel forking to multiple SIP devices
37 1
  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
38 111 Adrian Georgescu
  * Interactive Messaging (IM) and File transfer using MSRP protocol
39 169 Adrian Georgescu
  * Desktop sharing
40 169 Adrian Georgescu
  * Video calls
41 1
42 147 Adrian Georgescu
== Testing the library ==
43 34 Adrian Georgescu
44 150 Adrian Georgescu
Besides the Python software library itself, the repository contains ready to use command-line examples scripts for Linux and MacOSX that can be used to:
45 87 Adrian Georgescu
46 147 Adrian Georgescu
  * Setup IM or file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay]
47 147 Adrian Georgescu
  * Setup up VoIP sessions using speex wide-band codec
48 148 Adrian Georgescu
  * [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE and handle incoming NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events] [http://tools.ietf.org/html/rfc3856 presence], [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], [http://tools.ietf.org/html/rfc3857 watcher-info], [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary]
49 147 Adrian Georgescu
  * Manage [http://www.tools.ietf.org/html/rfc4825 XCAP] documents [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]
50 148 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://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services)
51 151 Adrian Georgescu
  * Setup up [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)
52 33 Adrian Georgescu
53 162 Adrian Georgescu
For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
54 103 Adrian Georgescu
55 93 Adrian Georgescu
== License == 
56 82 Adrian Georgescu
57 62 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
58 62 Adrian Georgescu
59 62 Adrian Georgescu
60 166 Adrian Georgescu
== Contributing ==
61 1
62 166 Adrian Georgescu
If you wish to become an active developer of this project, send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com].
63 103 Adrian Georgescu
64 105 Adrian Georgescu
We are looking for developers that can contribute with the following features: VNC desktop sharing, implementation for video sessions and real time text sessions (real time text using RTP [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)] and MSRP).