Version 452 (Adrian Georgescu, 02/22/2009 07:42 pm)

1 298 Adrian Georgescu
= Description =
2 432 Adrian Georgescu
[[TOC(WikiStart, Sip*, depth=2)]]
3 408 Adrian Georgescu
[[Image(SIPSIMPLE-client.png, align=right)]]
4 377 Adrian Georgescu
5 426 Adrian Georgescu
SIP SIMPLE client is a Python software library that allows for easy development of Internet
6 378 Adrian Georgescu
communications end-points based on SIP and related protocols for voice,
7 449 Adrian Georgescu
rich presence, session based instant messaging (IM), file transfers and desktop sharing. 
8 450 Adrian Georgescu
Other media types can be easily added by using an extensible high-level API.
9 1
10 346 Adrian Georgescu
== Background ==
11 346 Adrian Georgescu
12 403 Adrian Georgescu
SIP stands for 'Session Initiation Protocol', an IETF standard described by
13 382 Adrian Georgescu
[ RFC 3261]. SIP is an Internet application-layer control protocol that can establish,
14 346 Adrian Georgescu
modify and terminate multimedia sessions such as Internet telephony calls
15 346 Adrian Georgescu
(VoIP). Media can be added to (and removed from) an existing session.
16 346 Adrian Georgescu
17 346 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
18 383 Adrian Georgescu
mutually understand like audio, video, instant messaging (IM), file transfer,
19 346 Adrian Georgescu
desktop sharing and provides a generic event notification system with
20 346 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
21 346 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
22 346 Adrian Georgescu
busy line appearance.
23 331 Adrian Georgescu
24 1
== Features ==
25 1
26 412 Adrian Georgescu
The software allows you to create elegant real-time communications applications without having to read [ the +1200 RFC documents] behind it. As a library with a high-level [wiki:SipSimpleApiDocumentation API], the toolkit can be used to add voice, IM and Presence functionality to any network devices as long as Python/C environment is supported by such platform.
27 344 Adrian Georgescu
28 369 Adrian Georgescu
Additional to the SIP standards implemented by the underlying PJSIP library and exposes through a Python API, this project implements session based instant messaging (IM), file transfer and multi-party chat sessions using MSRP protocol and its relay extension, publication and subscription for rich presence information such as availability, moods, activities and geo-location, management for presence rules, resource lists, RLS services documents using XCAP protocol.
29 344 Adrian Georgescu
30 452 Adrian Georgescu
The complete feature set is described at [wiki:SipFeatures]
31 344 Adrian Georgescu
32 1
== Documentation ==
33 1
34 440 Adrian Georgescu
For installation instructions, API description and other documentation see the files under docs/ directory.  
35 431 Adrian Georgescu
36 439 Adrian Georgescu
 * [wiki:SipProjectStatus Projects status] - information about achieved milestones and roadmap 
37 419 Adrian Georgescu
 * [wiki:SipInstallation Installation guide] - how to install the library on your system
38 434 Adrian Georgescu
 * [wiki:SipTesting Testing the library] - how to test the library using the command line tools
39 436 Adrian Georgescu
 * [wiki:SipSimpleApiDocumentation Developer guide] - how to develop your own SIP applications using this library
40 311 Adrian Georgescu
41 235 Adrian Georgescu
== Support ==
42 235 Adrian Georgescu
43 443 Adrian Georgescu
The project is developed and supported by AG Projects. The support is provided on a best-effort basis. "best-effort" means that we try to solve the bugs you report or help fix your problems as soon as we can, subject to available resources.
44 400 Adrian Georgescu
45 443 Adrian Georgescu
To request support you must use the [ mailing list]. Bug reports must be submitted by opening a [ ticket]. To open ticket please Register first.