WikiStart

Version 224 (Adrian Georgescu, 10/20/2008 10:04 pm)

1 189 Adrian Georgescu
== Description == 
2 95 Ruud Klaver
3 214 Adrian Georgescu
SipClient is Python software library built on top of [http://pjsip.org PJSIP] that together
4 199 Adrian Georgescu
with an elegant middleware allows for easy development of Client/Server and
5 204 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols with
6 190 Adrian Georgescu
rich Presence, Interactive Messaging (IM) and File Transfer capabilities.
7 1
8 206 Adrian Georgescu
The goal of this project is to deliver the best Open Source Python
9 193 Adrian Georgescu
library for rich featured SIP User Agents, while hiding the complex
10 187 Adrian Georgescu
underlying functionality behind an easy to use high-level application
11 187 Adrian Georgescu
programming interface. Compared to other available SIP libraries, this
12 209 Adrian Georgescu
project provides beyond basic audio calls, multiple streams support for IM, voice and video sessions, 
13 210 Adrian Georgescu
Interactive  Messaging (IM), file transfer and multi-party chat sessions using MSRP protocol, 
14 220 Adrian Georgescu
publication and subscription for rich presence information like availability, moods, activities and geo-location, management for presence rules, 
15 210 Adrian Georgescu
resource lists, RLS services using XCAP protocol.
16 1
17 219 Adrian Georgescu
Shortly said, 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. If you read them all, some antidepressant and desintoxication is recommended after this effort. 
18 208 Adrian Georgescu
19 198 Adrian Georgescu
== Download  == 
20 180 Adrian Georgescu
21 198 Adrian Georgescu
For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list
22 180 Adrian Georgescu
23 180 Adrian Georgescu
{{{
24 1
deb	http://ag-projects.com/debian unstable main
25 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
26 1
}}}
27 180 Adrian Georgescu
28 180 Adrian Georgescu
Update the list of available software and install the software:
29 1
30 1
{{{
31 1
apt-get update
32 180 Adrian Georgescu
apt-get install sipclient
33 181 Adrian Georgescu
}}}
34 1
35 202 Adrian Georgescu
=== Other Unix distributions ===
36 1
37 198 Adrian Georgescu
To obtain the source code as tar archive go to:
38 1
39 1
[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] 
40 1
41 1
== Source code access ==
42 1
43 1
SipClient source code is using [http://darcs.net darcs] for version control. The darcs repository can be fetched with:
44 1
45 1
{{{
46 1
darcs get http://devel.ag-projects.com/repositories/pypjua
47 1
}}}
48 1
49 1
To obtain the changes after the intial get, go to the pypjua directory and run:
50 1
51 1
{{{
52 1
darcs pull
53 1
}}}
54 218 Adrian Georgescu
55 218 Adrian Georgescu
== Testing ==
56 218 Adrian Georgescu
57 224 Adrian Georgescu
This SIP SIMPLE software library has been closely developed together with and tested against the most popular SIP SIMPLE server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. Included with the library, a set of [wiki:testscripts command line tools] are available for setting up real time voice, IM and file transfer sessions, publish and subscribe to presence or other type of events:
58 218 Adrian Georgescu
59 218 Adrian Georgescu
 * sip_register - REGISTER a SIP end-point with a SIP Registrar
60 218 Adrian Georgescu
 * sip_rtp_audio_session - Setup a voice audio session (Voice over IP)
61 218 Adrian Georgescu
 * sip_msrp_im_session - Setup an IM session using MSRP protocol
62 218 Adrian Georgescu
 * sip_msrp_file_transfer - Perform file transfers using MSRP protocol
63 218 Adrian Georgescu
 * sip_message - Send text message in page mode using MESSAGE method
64 218 Adrian Georgescu
 * sip_publish_presence - PUBLISH presence to a SIP Presence Agent
65 218 Adrian Georgescu
 * sip_subscribe_presence - SUBSCRIBE to presence information
66 218 Adrian Georgescu
 * sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent
67 218 Adrian Georgescu
 * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
68 223 Adrian Georgescu
 * xcapclient - Manage presence policy and buddy lists on an XCAP server
69 218 Adrian Georgescu
70 218 Adrian Georgescu
For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
71 218 Adrian Georgescu
72 157 Adrian Georgescu
73 123 Adrian Georgescu
== End-user experiences ==
74 1
75 204 Adrian Georgescu
As a library with a high-level API, the toolkit can also be used to add voice, IM 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:
76 1
77 204 Adrian Georgescu
  * Setup up VoIP sessions using Internet wide-band codecs
78 202 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]
79 202 Adrian Georgescu
  * Create 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]
80 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]
81 203 Adrian Georgescu
  * Discover SIP end-point using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast) and [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services)
82 33 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)
83 191 Adrian Georgescu
84 191 Adrian Georgescu
== License == 
85 191 Adrian Georgescu
86 191 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
87 191 Adrian Georgescu
88 191 Adrian Georgescu
== Support ==
89 191 Adrian Georgescu
90 202 Adrian Georgescu
To open ticket please Register first. The ticketing support system is available only for registered users. Please beware that the support is provided by the community on a best-effort basis.
91 191 Adrian Georgescu
92 202 Adrian Georgescu
If you wish to contribute and become an active developer of this project, send your request by email to pypjua-devel@ag-projects.com.