WikiStart

Version 198 (Adrian Georgescu, 10/20/2008 08:14 pm)

1 189 Adrian Georgescu
== Description == 
2 95 Ruud Klaver
3 187 Adrian Georgescu
SipClient is Python software library built on top of PJSIP that together
4 190 Adrian Georgescu
with an elegant middleware allows for easy development of Client/Server or
5 190 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP protocol with
6 190 Adrian Georgescu
rich Presence, Interactive Messaging (IM) and File Transfer capabilities.
7 1
8 1
== Deliverables ==
9 1
10 187 Adrian Georgescu
The goal of this project is to deliver the best Python based Open Source
11 193 Adrian Georgescu
library for rich featured SIP User Agents, while hiding the complex
12 187 Adrian Georgescu
underlying functionality behind an easy to use high-level application
13 187 Adrian Georgescu
programming interface. Compared to other available SIP libraries, this
14 187 Adrian Georgescu
project provides session based Interactive Messaging (IM) using MSRP
15 187 Adrian Georgescu
protocol, multiple streams support and 'the missing' SIP-SIMPLE features for
16 187 Adrian Georgescu
rich presence: presence rules, resource lists, RLS services, rich PIDF and
17 187 Adrian Georgescu
XCAP policy.
18 1
19 198 Adrian Georgescu
== Testing ==
20 198 Adrian Georgescu
21 196 Adrian Georgescu
The library is tested against the most popular SIP server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. 
22 187 Adrian Georgescu
23 194 Adrian Georgescu
Besides the library, a set of [wiki:testscripts command line tools] are available for setting up real time voice, IM
24 187 Adrian Georgescu
and file transfer sessions, publish and subscribe to presence or other type
25 187 Adrian Georgescu
of events:
26 187 Adrian Georgescu
27 188 Adrian Georgescu
 * sip_register - REGISTER a SIP end-point with a SIP REGISTRAR
28 188 Adrian Georgescu
 * sip_rtp_audio_session - Setup a voice audio session (VoIP)
29 188 Adrian Georgescu
 * sip_msrp_im_session - Setup an IM session using MSRP protocol
30 188 Adrian Georgescu
 * sip_msrp_file_transfer - File Transfer session using MSRP protocol
31 188 Adrian Georgescu
 * sip_message - Send text message in page mode using MESSAGE method
32 188 Adrian Georgescu
 * sip_publish_presence - PUBLISH presence to a SIP Presence Agent
33 188 Adrian Georgescu
 * sip_subscribe_presence - SUBSCRIBE to presence information
34 188 Adrian Georgescu
 * sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent
35 1
 * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
36 1
37 198 Adrian Georgescu
== Download  == 
38 180 Adrian Georgescu
39 198 Adrian Georgescu
For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list
40 180 Adrian Georgescu
41 180 Adrian Georgescu
{{{
42 180 Adrian Georgescu
# AG Projects software
43 1
deb	http://ag-projects.com/debian unstable main
44 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
45 1
}}}
46 180 Adrian Georgescu
47 180 Adrian Georgescu
Update the list of available software and install the software:
48 1
49 1
{{{
50 1
apt-get update
51 180 Adrian Georgescu
apt-get install sipclient
52 180 Adrian Georgescu
}}}
53 181 Adrian Georgescu
54 198 Adrian Georgescu
=== Source code access ===
55 181 Adrian Georgescu
56 198 Adrian Georgescu
SipClient source code is using [http://darcs.net darcs] for version control. The darcs repository can be fetched with:
57 184 Adrian Georgescu
58 180 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua
59 198 Adrian Georgescu
60 198 Adrian Georgescu
To obtain the source code as tar archive go to:
61 198 Adrian Georgescu
62 198 Adrian Georgescu
[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] 
63 198 Adrian Georgescu
64 123 Adrian Georgescu
65 111 Adrian Georgescu
== End-user experiences ==
66 1
67 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. 
68 1
69 157 Adrian Georgescu
''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 
70 123 Adrian Georgescu
71 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:
72 123 Adrian Georgescu
73 1
  * Register SIP end-points
74 191 Adrian Georgescu
  * Setup up VoIP sessions using wide-band codecs
75 1
  * 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]
76 176 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]
77 1
  * 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]
78 1
  * 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)
79 1
  * 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)
80 1
81 1
For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
82 1
83 1
== License == 
84 1
85 1
The software is provided under the [source:LICENSE GPL LICENSE]
86 1
87 147 Adrian Georgescu
88 191 Adrian Georgescu
== Support ==
89 33 Adrian Georgescu
90 191 Adrian Georgescu
The project is supported via this wiki collaboration system provided at:
91 191 Adrian Georgescu
92 191 Adrian Georgescu
http://pypjua.org
93 191 Adrian Georgescu
94 191 Adrian Georgescu
To open ticket please Register first. The ticketing support system is
95 191 Adrian Georgescu
available only for registered users. Please beware that the support is
96 191 Adrian Georgescu
provided by the community on a best-effort basis.
97 191 Adrian Georgescu
98 191 Adrian Georgescu
If you wish to contribute and become an active developer of this project,
99 191 Adrian Georgescu
send your request by email to pypjua-devel@ag-projects.com.