WikiStart

Version 316 (Adrian Georgescu, 11/11/2008 11:31 am)

1 298 Adrian Georgescu
= Description =
2 95 Ruud Klaver
3 264 Adrian Georgescu
[http://www.tech-invite.com/Ti-sip-IDs-SIMPLE.html#charter SIP SIMPLE] client is a SIMPLE SIP client. Which leads to the question how SIMPLE is [http://www.tech-invite.com/Ti-sip-IDs-SIMPLE.html#charter SIMPLE]. So let's try again:
4 263 Adrian Georgescu
5 292 Adrian Georgescu
[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
6 234 Adrian Georgescu
SIP SIMPLE client is Python software library built on top of [http://pjsip.org PJSIP] that together
7 303 Adrian Georgescu
with middleware allows for easy development of Client/Server and
8 303 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols for
9 306 Adrian Georgescu
voice, video, presence, instant messaging (IM) and file transfer capabilities.
10 275 Adrian Georgescu
11 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. 
12 1
13 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. 
14 278 Adrian Georgescu
15 303 Adrian Georgescu
The package will run on any UNIX platform.
16 208 Adrian Georgescu
17 315 Adrian Georgescu
== Status ==
18 315 Adrian Georgescu
19 316 Adrian Georgescu
See [/roadmap?show=all Roadmap] and [source:TODO TODO] list for information about the project progress.
20 315 Adrian Georgescu
21 299 Adrian Georgescu
== Download and installation ==
22 180 Adrian Georgescu
23 312 Adrian Georgescu
For Debian or Ubuntu on an i386 architecture, add to /etc/apt/sources.list:
24 180 Adrian Georgescu
25 180 Adrian Georgescu
{{{
26 1
deb	http://ag-projects.com/debian unstable main
27 180 Adrian Georgescu
deb-src http://ag-projects.com/debian unstable main
28 1
}}}
29 180 Adrian Georgescu
30 312 Adrian Georgescu
Install AG Projects debian repository signing key:
31 1
32 1
{{{
33 1
wget http://download.ag-projects.com/agp-debian-gpg.key
34 1
apt-key add agp-debian-gpg.key
35 312 Adrian Georgescu
}}}
36 312 Adrian Georgescu
37 312 Adrian Georgescu
Install the software:
38 312 Adrian Georgescu
39 312 Adrian Georgescu
{{{
40 1
apt-get update
41 1
apt-get install sipclient
42 229 Adrian Georgescu
}}}
43 312 Adrian Georgescu
44 309 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. To obtain the source code as tar archive go to:
45 1
46 1
[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] 
47 287 Adrian Georgescu
48 1
49 299 Adrian Georgescu
== Testing the library ==
50 218 Adrian Georgescu
51 313 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  [wiki:CommandLineTools 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. 
52 281 Adrian Georgescu
53 279 Adrian Georgescu
 * [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar
54 280 Adrian Georgescu
 * [wiki:sip_rtp_audio_session sip_rtp_audio_session] - Setup a voice audio session (Voice over IP)
55 280 Adrian Georgescu
 * [wiki:sip_msrp_im_session sip_msrp_im_session] - Setup an IM session using MSRP protocol
56 280 Adrian Georgescu
 * [wiki:sip_msrp_file_transfer sip_msrp_file_transfer] - Perform file transfer using MSRP protocol
57 280 Adrian Georgescu
 * [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method
58 280 Adrian Georgescu
 * [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent
59 280 Adrian Georgescu
 * [wiki:sip_subscribe_presence sip_subscribe_presence]  - SUBSCRIBE to presence information
60 280 Adrian Georgescu
 * [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent
61 218 Adrian Georgescu
 * [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server
62 1
 * [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server
63 290 Adrian Georgescu
 * [wiki:xcap_pres_rules xcap_pres_rules] - Manage entries in the pres-rules XCAP document
64 157 Adrian Georgescu
65 299 Adrian Georgescu
== Supported platforms ==
66 1
67 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.
68 1
69 299 Adrian Georgescu
== Normative references ==
70 248 Adrian Georgescu
71 262 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:
72 249 Adrian Georgescu
73 295 Adrian Georgescu
 * XCAP protocol stack and client [http://www.tools.ietf.org/html/rfc4825 RFC4825]
74 296 Adrian Georgescu
 * XCAP pres-rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]
75 296 Adrian Georgescu
 * XCAP resource-lists and rls-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]
76 296 Adrian Georgescu
 * XCAP pidf-manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
77 295 Adrian Georgescu
 * MSRP protocol stack and client [http://tools.ietf.org/html/rfc4975 RFC4975]
78 256 Adrian Georgescu
 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
79 294 Adrian Georgescu
 * MSRP multi-party chat [http://tools.ietf.org/html/draft-ietf-simple-chat-02 draft-ietf-simple-chat-02]
80 296 Adrian Georgescu
 * SIP PUBLISH method [http://tools.ietf.org/html/rfc3903 RFC3903]
81 296 Adrian Georgescu
 * SIP SUBSCRIBE and SIP NOTIFY methods [http://tools.ietf.org/html/rfc3265 RFC3265]
82 296 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]
83 294 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]
84 254 Adrian Georgescu
 * Watcher Information event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
85 1
 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]
86 253 Adrian Georgescu
 * Message Waiting Indication event package [http://tools.ietf.org/html/rfc3842 RFC3842]
87 257 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]
88 1
 * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]
89 1
90 299 Adrian Georgescu
== License ==
91 1
92 1
The software is provided under the [source:LICENSE GPL LICENSE]
93 1
94 299 Adrian Georgescu
== Support ==
95 1
96 310 Adrian Georgescu
This project is developed and supported by [http://ag-projects.com AG Projects]. To request support you must open a ticket. To open ticket please Register first. The ticketing support system is available only for registered users. 
97 235 Adrian Georgescu
98 299 Adrian Georgescu
== Source code access ==
99 235 Adrian Georgescu
100 311 Adrian Georgescu
The source code can be downloaded using [http://darcs.net darcs] version control tool . The darcs repository can be fetched with:
101 235 Adrian Georgescu
102 235 Adrian Georgescu
{{{
103 311 Adrian Georgescu
darcs get http://devel.ag-projects.com/repositories/pypjua sipsimpleclient
104 235 Adrian Georgescu
}}}
105 235 Adrian Georgescu
106 311 Adrian Georgescu
To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:
107 235 Adrian Georgescu
108 1
{{{
109 314 Adrian Georgescu
cd sipsimpleclient
110 235 Adrian Georgescu
darcs pull
111 235 Adrian Georgescu
}}}
112 191 Adrian Georgescu
113 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.