WikiStart
Version 204 (Adrian Georgescu, 10/20/2008 08:21 pm)
1 | 189 | Adrian Georgescu | == Description == |
---|---|---|---|
2 | 95 | Ruud Klaver | |
3 | 187 | Adrian Georgescu | SipClient is Python software library built on top of PJSIP that together |
4 | 199 | Adrian Georgescu | with an elegant middleware allows for easy development of Client/Server and |
5 | 204 | Adrian Georgescu | Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols with |
6 | 190 | Adrian Georgescu | rich Presence, Interactive Messaging (IM) and File Transfer capabilities. |
7 | 1 | ||
8 | 187 | Adrian Georgescu | The goal of this project is to deliver the best Python based Open Source |
9 | 193 | Adrian Georgescu | library for rich featured SIP User Agents, while hiding the complex |
10 | 187 | Adrian Georgescu | underlying functionality behind an easy to use high-level application |
11 | 187 | Adrian Georgescu | programming interface. Compared to other available SIP libraries, this |
12 | 187 | Adrian Georgescu | project provides session based Interactive Messaging (IM) using MSRP |
13 | 187 | Adrian Georgescu | protocol, multiple streams support and 'the missing' SIP-SIMPLE features for |
14 | 187 | Adrian Georgescu | rich presence: presence rules, resource lists, RLS services, rich PIDF and |
15 | 187 | Adrian Georgescu | XCAP policy. |
16 | 1 | ||
17 | 198 | Adrian Georgescu | == Testing == |
18 | 198 | Adrian Georgescu | |
19 | 204 | Adrian Georgescu | This SIP SIMPLE software library has been closely developed together with and tested against the most popular SIP server software available today: [http://opensips.org OpenSIPs], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. With the library, a set of [wiki:testscripts 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: |
20 | 187 | Adrian Georgescu | |
21 | 204 | Adrian Georgescu | * sip_register - REGISTER a SIP end-point with a SIP Registar |
22 | 188 | Adrian Georgescu | * sip_rtp_audio_session - Setup a voice audio session (VoIP) |
23 | 188 | Adrian Georgescu | * sip_msrp_im_session - Setup an IM session using MSRP protocol |
24 | 188 | Adrian Georgescu | * sip_msrp_file_transfer - File Transfer session using MSRP protocol |
25 | 188 | Adrian Georgescu | * sip_message - Send text message in page mode using MESSAGE method |
26 | 188 | Adrian Georgescu | * sip_publish_presence - PUBLISH presence to a SIP Presence Agent |
27 | 188 | Adrian Georgescu | * sip_subscribe_presence - SUBSCRIBE to presence information |
28 | 188 | Adrian Georgescu | * sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent |
29 | 1 | * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server |
|
30 | 1 | ||
31 | 202 | Adrian Georgescu | For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info] |
32 | 202 | Adrian Georgescu | |
33 | 198 | Adrian Georgescu | == Download == |
34 | 180 | Adrian Georgescu | |
35 | 198 | Adrian Georgescu | For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list |
36 | 180 | Adrian Georgescu | |
37 | 180 | Adrian Georgescu | {{{ |
38 | 180 | Adrian Georgescu | # AG Projects software |
39 | 1 | deb http://ag-projects.com/debian unstable main |
|
40 | 180 | Adrian Georgescu | deb-src http://ag-projects.com/debian unstable main |
41 | 1 | }}} |
|
42 | 180 | Adrian Georgescu | |
43 | 180 | Adrian Georgescu | Update the list of available software and install the software: |
44 | 1 | ||
45 | 1 | {{{ |
|
46 | 1 | apt-get update |
|
47 | 180 | Adrian Georgescu | apt-get install sipclient |
48 | 181 | Adrian Georgescu | }}} |
49 | 1 | ||
50 | 202 | Adrian Georgescu | === Other Unix distributions === |
51 | 1 | ||
52 | 198 | Adrian Georgescu | To obtain the source code as tar archive go to: |
53 | 1 | ||
54 | 1 | [http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] |
|
55 | 1 | ||
56 | 202 | Adrian Georgescu | == Source code access == |
57 | 1 | ||
58 | 202 | Adrian Georgescu | SipClient source code is using [http://darcs.net darcs] for version control. The darcs repository can be fetched with: |
59 | 202 | Adrian Georgescu | |
60 | 202 | Adrian Georgescu | darcs get http://devel.ag-projects.com/repositories/pypjua |
61 | 202 | Adrian Georgescu | |
62 | 202 | Adrian Georgescu | |
63 | 1 | == End-user experiences == |
|
64 | 1 | ||
65 | 1 | 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. |
|
66 | 157 | Adrian Georgescu | |
67 | 123 | Adrian Georgescu | ''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' |
68 | 1 | ||
69 | 204 | Adrian Georgescu | As a library with a high-level API, the toolkit can also be used to add voice, IM 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: |
70 | 1 | ||
71 | 204 | Adrian Georgescu | * Setup up VoIP sessions using Internet wide-band codecs |
72 | 202 | Adrian Georgescu | * 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] |
73 | 202 | Adrian Georgescu | * Create 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] |
74 | 147 | Adrian Georgescu | * 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] |
75 | 203 | Adrian Georgescu | * Discover SIP end-point using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast) and [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services) |
76 | 33 | Adrian Georgescu | * 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) |
77 | 191 | Adrian Georgescu | |
78 | 191 | Adrian Georgescu | == License == |
79 | 191 | Adrian Georgescu | |
80 | 191 | Adrian Georgescu | The software is provided under the [source:LICENSE GPL LICENSE] |
81 | 191 | Adrian Georgescu | |
82 | 191 | Adrian Georgescu | == Support == |
83 | 191 | Adrian Georgescu | |
84 | 202 | Adrian Georgescu | To open ticket please Register first. The ticketing support system is available only for registered users. Please beware that the support is provided by the community on a best-effort basis. |
85 | 191 | Adrian Georgescu | |
86 | 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. |