WikiStart

Version 439 (Adrian Georgescu, 02/22/2009 01:18 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 386 Adrian Georgescu
rich presence, instant messaging (IM), file transfers and desktop sharing. 
8 427 Adrian Georgescu
Other session 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
[http://tools.ietf.org/html/rfc3261 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 transparently supports name mapping and redirection services, which
18 346 Adrian Georgescu
supports personal mobility, users can maintain a single externally visible
19 346 Adrian Georgescu
address identifier, which can be in the form of a standard email address or
20 346 Adrian Georgescu
E.164 telephone number regardless of their physical network location.
21 346 Adrian Georgescu
22 346 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
23 383 Adrian Georgescu
mutually understand like audio, video, instant messaging (IM), file transfer,
24 346 Adrian Georgescu
desktop sharing and provides a generic event notification system with
25 346 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
26 346 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
27 346 Adrian Georgescu
busy line appearance.
28 331 Adrian Georgescu
29 1
== Features ==
30 1
31 412 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. 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.
32 344 Adrian Georgescu
33 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.
34 344 Adrian Georgescu
35 420 Adrian Georgescu
 * 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], [http://tools.ietf.org/html/rfc4481 RFC4481], [http://tools.ietf.org/html/rfc4482 RFC4482], [http://tools.ietf.org/html/rfc5196 RFC5196]
36 420 Adrian Georgescu
 * Presence Watcher-info event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
37 381 Adrian Georgescu
 * XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825]
38 420 Adrian Georgescu
 * XCAP presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025], resource-lists, RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826], PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
39 1
 * XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]
40 420 Adrian Georgescu
 * MSRP conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]
41 344 Adrian Georgescu
 * MSRP protocol [http://tools.ietf.org/html/rfc4975 RFC4975]
42 344 Adrian Georgescu
 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
43 344 Adrian Georgescu
 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]
44 420 Adrian Georgescu
 * MSRP file transfer [http://tools.ietf.org/html/draft-ietf-mmusic-file-transfer-mech-11 draft-ietf-mmusic-file-transfer-mech-11]
45 421 Adrian Georgescu
 * Desktop sharing [http://tools.ietf.org/html/draft-garcia-mmusic-sdp-collaboration-00 draft-garcia-mmusic-sdp-collaboration-00]
46 370 Adrian Georgescu
 * Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842]
47 370 Adrian Georgescu
 * Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]
48 344 Adrian Georgescu
49 1
== Documentation ==
50 1
51 439 Adrian Georgescu
For download and installation instructions, API description and other documentation see the files under docs/ directory.  
52 431 Adrian Georgescu
53 439 Adrian Georgescu
 * [wiki:SipProjectStatus Projects status] - information about achieved milestones and roadmap 
54 419 Adrian Georgescu
 * [wiki:SipInstallation Installation guide] - how to install the library on your system
55 434 Adrian Georgescu
 * [wiki:SipTesting Testing the library] - how to test the library using the command line tools
56 436 Adrian Georgescu
 * [wiki:SipSimpleApiDocumentation Developer guide] - how to develop your own SIP applications using this library
57 311 Adrian Georgescu
58 235 Adrian Georgescu
== Support ==
59 235 Adrian Georgescu
60 399 Adrian Georgescu
The project is developed and supported by AG Projects. The support is provided on a
61 392 Adrian Georgescu
best-effort basis. "best-effort" means that we try to solve the bugs you
62 392 Adrian Georgescu
report or help fix your problems as soon as we can, subject to available
63 1
resources.
64 1
65 400 Adrian Georgescu
To request support you must use the mailing list available at
66 1
67 392 Adrian Georgescu
http://lists.ag-projects.com/mailman/listinfo/sipclient
68 1
69 399 Adrian Georgescu
Patches and bug reports must be submitted by opening a ticket at
70 396 Adrian Georgescu
71 392 Adrian Georgescu
http://sipsimpleclient.com/newticket
72 392 Adrian Georgescu
73 424 Adrian Georgescu
To open ticket please Register first. To submit a patch you must be familiar with the darcs version control system from http://wiki.darcs.net/DarcsWiki
74 400 Adrian Georgescu
75 438 Adrian Georgescu
If you wish to contribute as an active developer, send your request by email to devel@ag-projects.com. See [wiki:SipContributions Third-party contributions] page for more information.