WikiStart

Version 196 (Adrian Georgescu, 10/20/2008 06:46 pm)

1 133 Adrian Georgescu
[[Image(htdocs:SIPUA-design-70.png, align=right, link=wiki:SIPUADesign)]]
2 96 Ruud Klaver
3 189 Adrian Georgescu
== Description == 
4 95 Ruud Klaver
5 187 Adrian Georgescu
SipClient is Python software library built on top of PJSIP that together
6 190 Adrian Georgescu
with an elegant middleware allows for easy development of Client/Server or
7 190 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP protocol with
8 190 Adrian Georgescu
rich Presence, Interactive Messaging (IM) and File Transfer capabilities.
9 1
10 1
== Deliverables ==
11 1
12 187 Adrian Georgescu
The goal of this project is to deliver the best Python based Open Source
13 193 Adrian Georgescu
library for rich featured SIP User Agents, while hiding the complex
14 187 Adrian Georgescu
underlying functionality behind an easy to use high-level application
15 187 Adrian Georgescu
programming interface. Compared to other available SIP libraries, this
16 187 Adrian Georgescu
project provides session based Interactive Messaging (IM) using MSRP
17 187 Adrian Georgescu
protocol, multiple streams support and 'the missing' SIP-SIMPLE features for
18 187 Adrian Georgescu
rich presence: presence rules, resource lists, RLS services, rich PIDF and
19 187 Adrian Georgescu
XCAP policy.
20 1
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 188 Adrian Georgescu
 * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
36 1
37 182 Adrian Georgescu
== INSTALL procedure  == 
38 182 Adrian Georgescu
39 182 Adrian Georgescu
The software has been tested on Linux Debian and MacOSX 10.5 (Leopard).
40 123 Adrian Georgescu
41 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:
42 1
43 180 Adrian Georgescu
{{{
44 180 Adrian Georgescu
wget http://download.ag-projects.com/agp-debian-gpg.key
45 180 Adrian Georgescu
apt-key add agp-debian-gpg.key
46 180 Adrian Georgescu
}}}
47 180 Adrian Georgescu
48 180 Adrian Georgescu
Add the following lines to /etc/apt/sources.list
49 180 Adrian Georgescu
50 180 Adrian Georgescu
{{{
51 180 Adrian Georgescu
# AG Projects software
52 180 Adrian Georgescu
deb	http://ag-projects.com/debian unstable main
53 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
54 180 Adrian Georgescu
}}}
55 180 Adrian Georgescu
56 184 Adrian Georgescu
Update the list of available software and install the software:
57 180 Adrian Georgescu
58 180 Adrian Georgescu
{{{
59 181 Adrian Georgescu
apt-get update
60 181 Adrian Georgescu
apt-get install sipclient
61 181 Adrian Georgescu
}}}
62 181 Adrian Georgescu
63 184 Adrian Georgescu
For other distributions or to obtain the source code go to:
64 180 Adrian Georgescu
65 183 Adrian Georgescu
[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] 
66 180 Adrian Georgescu
67 181 Adrian Georgescu
To obtain access to the version controlled software repository:
68 181 Adrian Georgescu
69 181 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua
70 123 Adrian Georgescu
71 111 Adrian Georgescu
== End-user experiences ==
72 1
73 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. 
74 1
75 157 Adrian Georgescu
''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' 
76 123 Adrian Georgescu
77 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:
78 123 Adrian Georgescu
79 1
  * Register SIP end-points
80 191 Adrian Georgescu
  * Setup up VoIP sessions using wide-band codecs
81 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]
82 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]
83 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]
84 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)
85 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)
86 1
87 1
For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
88 1
89 1
== License == 
90 1
91 1
The software is provided under the [source:LICENSE GPL LICENSE]
92 1
93 147 Adrian Georgescu
94 191 Adrian Georgescu
== Support ==
95 33 Adrian Georgescu
96 191 Adrian Georgescu
The project is supported via this wiki collaboration system provided at:
97 191 Adrian Georgescu
98 191 Adrian Georgescu
http://pypjua.org
99 191 Adrian Georgescu
100 191 Adrian Georgescu
To open ticket please Register first. The ticketing support system is
101 191 Adrian Georgescu
available only for registered users. Please beware that the support is
102 191 Adrian Georgescu
provided by the community on a best-effort basis.
103 191 Adrian Georgescu
104 191 Adrian Georgescu
If you wish to contribute and become an active developer of this project,
105 191 Adrian Georgescu
send your request by email to pypjua-devel@ag-projects.com.