Project

General

Profile

Actions
History

WikiStart » History » Revision 321

« Previous | Revision 321/574 (diff) | Next »
Adrian Georgescu, 11/26/2008 11:02 PM

= Description =

[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
SIP SIMPLE client is Python software library built on top of [http://pjsip.org PJSIP] that together
with [wiki:MiddlewareDesign middleware] allows for easy development of Client/Server and
Peer-to-Peer Internet communications end-points based on SIP SIMPLE protocols for
voice, video, presence, instant messaging (IM) and file transfer capabilities.

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.

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.

The package will run on any UNIX platform.

Status

See [/roadmap?show=all Roadmap] and [source:TODO TODO] list for information about the project progress.

Download and installation

For Debian or Ubuntu on an i386 architecture, add to /etc/apt/sources.list:

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

Install AG Projects debian repository signing key:

{{{
wget http://download.ag-projects.com/agp-debian-gpg.key
apt-key add agp-debian-gpg.key
}}}

Install the software:

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

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:

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

Testing the library

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.

  • [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar
  • [wiki:sip_rtp_audio_session sip_audio_session] - Setup a voice audio session (Voice over IP)
  • [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and File transfer using MSRP protocol
  • [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method
  • [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent
  • [wiki:sip_subscribe_presence sip_subscribe_presence] - SUBSCRIBE to presence information
  • [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent
  • [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server
  • [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server
  • [wiki:xcap_pres_rules xcap_pres_rules] - Manage content of pres-rules XCAP document
  • [wiki:xcap_rls_services] - Manage content of RLS services XCAP document
Supported platforms

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.

Normative references

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:

License

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

Support

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.

Version control repository access

The source code can be downloaded using [http://darcs.net darcs] version control tool . The darcs repository can be fetched with:

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

To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:

{{{
cd sipsimpleclient
darcs pull
}}}

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 · 321 revisions