WikiStart

Version 336 (Adrian Georgescu, 11/30/2008 09:06 am)

1 298 Adrian Georgescu
= Description =
2 95 Ruud Klaver
3 292 Adrian Georgescu
[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
4 326 Adrian Georgescu
SIP SIMPLE client is a Python software library built on top of [http://pjsip.org PJSIP] that together
5 318 Adrian Georgescu
with [wiki:MiddlewareDesign middleware] allows for easy development of Client/Server and
6 303 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols for
7 306 Adrian Georgescu
voice, video, presence, instant messaging (IM) and file transfer capabilities.
8 275 Adrian Georgescu
9 303 Adrian Georgescu
The goal of this project is to deliver the best Open Source Python library for rich featured SIP end-points, while hiding the complex underlying functionality behind an easy to use high-level application-programming interface. This package supports to the SDP negotiation, audio codecs and NAT traversal functionality provided by PJSIP and will thus deliver rich communications combining instant messaging (IM), voice and video streams. It also supports file transfer and multi-party chat sessions using MSRP protocol, publication and subscription for rich presence information such as availability, moods, activities and geo-location, management for presence rules,  resource lists, RLS services using XCAP protocol. 
10 1
11 303 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. 
12 278 Adrian Georgescu
13 331 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
14 331 Adrian Georgescu
15 315 Adrian Georgescu
== Status ==
16 1
17 331 Adrian Georgescu
See [/roadmap?show=all Completed milestones], [/roadmap Roadmap] and [source:TODO TODO] list for information about the project progress.
18 299 Adrian Georgescu
19 1
== Download and installation ==
20 180 Adrian Georgescu
21 331 Adrian Georgescu
=== Tarball ===
22 1
23 331 Adrian Georgescu
Tarball with the latest released version is available at [http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/]
24 331 Adrian Georgescu
25 331 Adrian Georgescu
=== Binary packages ===
26 331 Adrian Georgescu
27 334 Adrian Georgescu
Binary packages are available for Debian or Ubuntu on i386 and amd64 architectures. To install add the following lines to /etc/apt/sources.list:
28 331 Adrian Georgescu
29 180 Adrian Georgescu
{{{
30 1
deb	http://ag-projects.com/debian unstable main
31 1
deb-src http://ag-projects.com/debian unstable main
32 180 Adrian Georgescu
}}}
33 312 Adrian Georgescu
34 1
Install AG Projects debian repository signing key:
35 1
36 1
{{{
37 1
wget http://download.ag-projects.com/agp-debian-gpg.key
38 312 Adrian Georgescu
apt-key add agp-debian-gpg.key
39 312 Adrian Georgescu
}}}
40 324 Adrian Georgescu
41 312 Adrian Georgescu
Install the software:
42 312 Adrian Georgescu
43 312 Adrian Georgescu
{{{
44 1
apt-get update
45 1
apt-get install sipclient
46 229 Adrian Georgescu
}}}
47 324 Adrian Georgescu
48 324 Adrian Georgescu
49 333 Adrian Georgescu
Install dependencies that are not yet available as debian package:
50 324 Adrian Georgescu
51 325 Adrian Georgescu
{{{
52 324 Adrian Georgescu
sudo apt-get install mercurial python-setuptools
53 335 Adrian Georgescu
54 324 Adrian Georgescu
# Download and install eventlet for twisted:
55 324 Adrian Georgescu
hg clone http://devel.ag-projects.com/~denis/cgi-bin/hgweb.cgi/eventlet_twisted
56 324 Adrian Georgescu
cd eventlet_twisted
57 324 Adrian Georgescu
58 324 Adrian Georgescu
# To update the eventlet_twisted at a later date:
59 1
cd eventlet_twisted
60 1
hg pull
61 1
hg update
62 335 Adrian Georgescu
63 1
sudo python setup.py install
64 336 Adrian Georgescu
}}}
65 336 Adrian Georgescu
66 336 Adrian Georgescu
67 1
68 331 Adrian Georgescu
=== Version control ===
69 1
70 331 Adrian Georgescu
The source code can is available using [http://darcs.net darcs] version control tool. The darcs repository can be fetched with:
71 1
72 331 Adrian Georgescu
{{{
73 331 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua sipsimpleclient
74 331 Adrian Georgescu
}}}
75 1
76 331 Adrian Georgescu
To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:
77 331 Adrian Georgescu
78 331 Adrian Georgescu
{{{
79 331 Adrian Georgescu
cd sipsimpleclient
80 331 Adrian Georgescu
darcs pull
81 331 Adrian Georgescu
}}}
82 331 Adrian Georgescu
83 331 Adrian Georgescu
== Documentation ==
84 331 Adrian Georgescu
85 331 Adrian Georgescu
Manual installation instructions are available in [source:docs/INSTALL.debian INSTALL.debian], [source:docs/INSTALL.linux INSTALL.linux], [source:docs/INSTALL.osx INSTALL.osx] and [source:docs/INSTALL.maemo INSTALL.maemo] for the corresponding platforms.
86 331 Adrian Georgescu
87 331 Adrian Georgescu
88 299 Adrian Georgescu
== Testing the library ==
89 218 Adrian Georgescu
90 322 Adrian Georgescu
SIP SIMPLE client is 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 command line tools are available for setting up audio, Instant Messaging and file transfer sessions, publish and subscribe to presence or other type of events. 
91 281 Adrian Georgescu
92 279 Adrian Georgescu
 * [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar
93 320 Adrian Georgescu
 * [wiki:sip_rtp_audio_session sip_audio_session] - Setup a voice audio session (Voice over IP)
94 320 Adrian Georgescu
 * [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and File transfer using MSRP protocol
95 280 Adrian Georgescu
 * [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method
96 280 Adrian Georgescu
 * [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent
97 280 Adrian Georgescu
 * [wiki:sip_subscribe_presence sip_subscribe_presence]  - SUBSCRIBE to presence information
98 280 Adrian Georgescu
 * [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent
99 218 Adrian Georgescu
 * [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server
100 1
 * [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server
101 321 Adrian Georgescu
 * [wiki:xcap_pres_rules xcap_pres_rules] - Manage content of pres-rules XCAP document
102 262 Adrian Georgescu
 * [wiki:xcap_rls_services] - Manage content of RLS services XCAP document
103 1
104 299 Adrian Georgescu
== Supported platforms ==
105 248 Adrian Georgescu
106 262 Adrian Georgescu
As a library with a high-level API, the toolkit can be used to add voice, IM and Presence functionality to any Internet device as long as Python/C environment is supported by such platform.
107 257 Adrian Georgescu
108 1
== Normative references ==
109 1
110 299 Adrian Georgescu
Additional to the SIP standards implemented by the underlying [http://www.pjsip.org/sip_media_features.htm PJSIP library] and exposed by SIP SIMPLE client in a Python API, this project implements in Python language the following standards:
111 1
112 1
 * XCAP protocol stack and client [http://www.tools.ietf.org/html/rfc4825 RFC4825]
113 1
 * XCAP pres-rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]
114 299 Adrian Georgescu
 * XCAP resource-lists and rls-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]
115 1
 * XCAP pidf-manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
116 329 Adrian Georgescu
 * MSRP protocol stack and client [http://tools.ietf.org/html/rfc4975 RFC4975]
117 329 Adrian Georgescu
 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
118 330 Adrian Georgescu
 * MSRP multi-party chat [http://tools.ietf.org/html/draft-ietf-simple-chat-02 draft-ietf-simple-chat-02]
119 235 Adrian Georgescu
 * SIP PUBLISH method [http://tools.ietf.org/html/rfc3903 RFC3903]
120 317 Adrian Georgescu
 * SIP SUBSCRIBE and SIP NOTIFY methods [http://tools.ietf.org/html/rfc3265 RFC3265]
121 235 Adrian Georgescu
 * Rich Presence Information Data model and Format (RPIDF) [http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]
122 311 Adrian Georgescu
 * XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]
123 235 Adrian Georgescu
 * Watcher Information event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
124 235 Adrian Georgescu
 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]
125 311 Adrian Georgescu
 * Message Waiting Indication event package [http://tools.ietf.org/html/rfc3842 RFC3842]
126 235 Adrian Georgescu
 * Bonjour multicast DNS [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt draft-lee-sip-dns-sd-uri-02]
127 235 Adrian Georgescu
 * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]
128 311 Adrian Georgescu
129 235 Adrian Georgescu
== Support ==
130 1
131 314 Adrian Georgescu
This project is developed and supported by [http://ag-projects.com AG Projects]. 
132 235 Adrian Georgescu
133 332 Adrian Georgescu
To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users. 
134 191 Adrian Georgescu
135 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.