Project

General

Profile

Actions
History

WikiStart » History » Revision 231

« Previous | Revision 231/574 (diff) | Next »
Adrian Georgescu, 10/21/2008 09:48 PM

Description

SipClient is Python software library built on top of [http://pjsip.org PJSIP] that together
with an elegant middleware allows for easy development of Client/Server and
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols with
voice, video (VoIP), presence, interactive messaging (IM) and file transfer capabilities.

The goal of this project is to deliver the best Open Source Python
library for rich featured SIP User Agents, while hiding the complex
underlying functionality behind an easy to use high-level application
programming interface. Compared to other available SIP libraries, this
project provides beyond basic audio calls, multiple streams support for IM, voice and video sessions,
Interactive Messaging (IM), file transfer and multi-party chat sessions using MSRP protocol,
publication and subscription for rich presence information like availability, moods, activities and geo-location, management for presence rules,
resource lists, RLS services using XCAP protocol.

Shortly said, this software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. If you read them all, some antidepressant and desintoxication is recommended after this effort.

Download software

For Debian testing or unstable on an i386 architecture, add the following lines to /etc/apt/sources.list

{{{
deb http://ag-projects.com/debian unstable main
deb-src http://ag-projects.com/debian unstable main
}}}

Update the list of available software and install the software:

{{{
apt-get update
apt-get install sipclient
}}}

For MacOSX 10.5 (Leopard) on an Intel architecture add these lines at the end of /sw/etc/apt/sources.list:

{{{
deb http://ag-projects.com/fink local main
deb http://ag-projects.com/fink stable main crypto
deb http://ag-projects.com/fink unstable main crypto
}}}

Update the list of available software and install the software:

{{{
sudo apt-get update
sudo apt-get install sipclient
}}}

Other Unix distributions

To obtain the source code as tar archive go to:

[http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/]

Source code access

SipClient source code is using [http://darcs.net darcs] for version control. The darcs repository can be fetched with:

{{{
darcs get http://devel.ag-projects.com/repositories/pypjua
}}}

To obtain the changes after the intial get, go to the pypjua directory and run:

{{{
darcs pull
}}}

Testing

This SIP SIMPLE software library has been 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: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:

  • sip_register - REGISTER a SIP end-point with a SIP Registrar
  • sip_rtp_audio_session - Setup a voice audio session (Voice over IP)
  • sip_msrp_im_session - Setup an IM session using MSRP protocol
  • sip_msrp_file_transfer - Perform file transfer using MSRP protocol
  • sip_message - Send/receive text in page mode using SIP MESSAGE method
  • sip_publish_presence - PUBLISH presence to a SIP Presence Agent
  • sip_subscribe_presence - SUBSCRIBE to presence information
  • sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent
  • sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server
  • xcapclient - Manage presence policy and buddy lists on an XCAP server

For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]

End-user experiences

As a library with a high-level API, the toolkit can also be used to add voice, IM and Presence functionality to any networked devices as long as Python/C environments are 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:

License

The software is provided under the [source:LICENSE GPL LICENSE]

Support

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.

If you wish to contribute and become an active developer of this project, send your request by email to .

Updated by Adrian Georgescu about 16 years ago · 231 revisions