WikiStart

Version 207 (Adrian Georgescu, 10/20/2008 08:32 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 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 206 Adrian Georgescu
project provides beyond basic audio calls, session based Interactive 
13 207 Adrian Georgescu
Messaging (IM) using MSRP protocol, multiple streams support, rich 
14 207 Adrian Georgescu
presence (RPIDF) and  management for presence rules, resource lists, RLS services using XCAP protocol.
15 1
16 198 Adrian Georgescu
== Testing ==
17 198 Adrian Georgescu
18 204 Adrian Georgescu
This SIP SIMPLE software library has been closely developed together with and tested against the most popular SIP server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. 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:
19 187 Adrian Georgescu
20 204 Adrian Georgescu
 * sip_register - REGISTER a SIP end-point with a SIP Registar
21 188 Adrian Georgescu
 * sip_rtp_audio_session - Setup a voice audio session (VoIP)
22 188 Adrian Georgescu
 * sip_msrp_im_session - Setup an IM session using MSRP protocol
23 188 Adrian Georgescu
 * sip_msrp_file_transfer - File Transfer session using MSRP protocol
24 188 Adrian Georgescu
 * sip_message - Send text message in page mode using MESSAGE method
25 188 Adrian Georgescu
 * sip_publish_presence - PUBLISH presence to a SIP Presence Agent
26 188 Adrian Georgescu
 * sip_subscribe_presence - SUBSCRIBE to presence information
27 188 Adrian Georgescu
 * sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent
28 1
 * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
29 1
30 202 Adrian Georgescu
For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
31 202 Adrian Georgescu
32 198 Adrian Georgescu
== Download  == 
33 180 Adrian Georgescu
34 198 Adrian Georgescu
For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list
35 180 Adrian Georgescu
36 180 Adrian Georgescu
{{{
37 180 Adrian Georgescu
# AG Projects software
38 1
deb	http://ag-projects.com/debian unstable main
39 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
40 1
}}}
41 180 Adrian Georgescu
42 180 Adrian Georgescu
Update the list of available software and install the software:
43 1
44 1
{{{
45 1
apt-get update
46 180 Adrian Georgescu
apt-get install sipclient
47 181 Adrian Georgescu
}}}
48 1
49 202 Adrian Georgescu
=== Other Unix distributions ===
50 1
51 198 Adrian Georgescu
To obtain the source code as tar archive go to:
52 1
53 1
[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] 
54 1
55 202 Adrian Georgescu
== Source code access ==
56 1
57 202 Adrian Georgescu
SipClient source code is using [http://darcs.net darcs] for version control. The darcs repository can be fetched with:
58 202 Adrian Georgescu
59 202 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua
60 202 Adrian Georgescu
61 202 Adrian Georgescu
62 1
== End-user experiences ==
63 1
64 1
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. 
65 157 Adrian Georgescu
66 123 Adrian Georgescu
''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 
67 1
68 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:
69 1
70 204 Adrian Georgescu
  * Setup up VoIP sessions using Internet wide-band codecs
71 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]
72 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]
73 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]
74 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)
75 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)
76 191 Adrian Georgescu
77 191 Adrian Georgescu
== License == 
78 191 Adrian Georgescu
79 191 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
80 191 Adrian Georgescu
81 191 Adrian Georgescu
== Support ==
82 191 Adrian Georgescu
83 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.
84 191 Adrian Georgescu
85 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.