WikiStart

Version 181 (Adrian Georgescu, 10/13/2008 06:25 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 179 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 Presence, IM and file transfer capabilities (SIP SIMPLE).
6 178 Adrian Georgescu
7 14 Adrian Georgescu
== Deliverables ==
8 168 Adrian Georgescu
9 179 Adrian Georgescu
The goal of this project is to deliver the best Open Source development kit for rich featured SIP User Agents, while hiding the complex underlying functionality behind an easy to use high-level application programming
10 179 Adrian Georgescu
interface. Compared to other available SIP libraries, this project provides session based Interactive Messaging (IM) using MSRP protocol, multiple streams support, 'the missing' SIP-SIMPLE features for rich presence (presence rules, resource lists, RLS services, rich PIDF and XCAP policy).
11 47 Adrian Georgescu
12 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]. 
13 1
14 138 Adrian Georgescu
== Download  == 
15 123 Adrian Georgescu
16 180 Adrian Georgescu
For people running Debian testing or unstable on an i386 architecture there is an official public repository provided by AG Projects. Install the AG Projects debian software signing key:
17 1
18 180 Adrian Georgescu
{{{
19 180 Adrian Georgescu
wget http://download.ag-projects.com/agp-debian-gpg.key
20 180 Adrian Georgescu
apt-key add agp-debian-gpg.key
21 180 Adrian Georgescu
}}}
22 180 Adrian Georgescu
23 180 Adrian Georgescu
Add the following lines to /etc/apt/sources.list
24 180 Adrian Georgescu
25 180 Adrian Georgescu
{{{
26 180 Adrian Georgescu
# AG Projects software
27 180 Adrian Georgescu
deb	http://ag-projects.com/debian unstable main
28 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
29 180 Adrian Georgescu
}}}
30 180 Adrian Georgescu
31 180 Adrian Georgescu
Update the list of available software:
32 180 Adrian Georgescu
33 180 Adrian Georgescu
{{{
34 180 Adrian Georgescu
apt-get update
35 180 Adrian Georgescu
}}}
36 180 Adrian Georgescu
37 181 Adrian Georgescu
Install the software:
38 181 Adrian Georgescu
39 181 Adrian Georgescu
{{{
40 181 Adrian Georgescu
apt-get install sipclient
41 181 Adrian Georgescu
}}}
42 181 Adrian Georgescu
43 180 Adrian Georgescu
For other distributions or the source code go to:
44 180 Adrian Georgescu
45 180 Adrian Georgescu
[http://download.ag-projects.com/SipClient/http://download.ag-projects.com/SipClient/] 
46 180 Adrian Georgescu
47 181 Adrian Georgescu
To obtain access to the version controlled software repository:
48 181 Adrian Georgescu
49 181 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua
50 123 Adrian Georgescu
51 111 Adrian Georgescu
== End-user experiences ==
52 1
53 179 Adrian Georgescu
The software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. 
54 1
55 157 Adrian Georgescu
''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 
56 123 Adrian Georgescu
57 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:
58 123 Adrian Georgescu
59 147 Adrian Georgescu
  * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711
60 1
  * Zero configuration server-less communication over LAN (Bonjour)
61 169 Adrian Georgescu
  * Parallel forking to multiple SIP devices
62 1
  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
63 111 Adrian Georgescu
  * Interactive Messaging (IM) and File transfer using MSRP protocol
64 169 Adrian Georgescu
  * Desktop sharing
65 169 Adrian Georgescu
  * Video calls
66 1
67 147 Adrian Georgescu
== Testing the library ==
68 34 Adrian Georgescu
69 176 Adrian Georgescu
Besides the Python software library itself, the repository contains ready to use fully featured [wiki:testscripts command-line examples scripts] that can be used to:
70 1
71 176 Adrian Georgescu
  * Register SIP end-points
72 176 Adrian Georgescu
  * Setup up VoIP sessions
73 176 Adrian Georgescu
  * Setup Interactive Messaging (IM) and file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay]
74 177 Adrian Georgescu
  * Simulate SIP SIMPLE end-points: [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE, NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events], presence  data model and format ([http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]), [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], watcher-info ([http://tools.ietf.org/html/rfc3857 RFC3857],[http://tools.ietf.org/html/rfc3858 RFC3858] ), [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary]
75 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]
76 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)
77 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)
78 33 Adrian Georgescu
79 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]
80 103 Adrian Georgescu
81 93 Adrian Georgescu
== License == 
82 82 Adrian Georgescu
83 62 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
84 62 Adrian Georgescu
85 62 Adrian Georgescu
86 166 Adrian Georgescu
== Contributing ==
87 1
88 170 Adrian Georgescu
We are looking for contributions related to DHT overlay (P2PSIP), desktop sharing, video sessions and real time text using RTP [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)].
89 103 Adrian Georgescu
90 170 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].