SIP SIMPLE Client SDK

== Project description == 

PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with a clever middleware allows for easy development of SIP User agents that run on desktop computers running Mac OS X, Linux and Windows operating systems, portable Internet devices like Nokia 810, Apple iPhone or Android mobile phones.

== License == 

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

== Deliverables ==

The goal of this project is to deliver an Open Source development kit for a rich featured SIP User Agent while hiding the complex underlying functionality behind an easy to use high-level application programming interface. 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).   

Using this software you are able to create elegant real-time communications applications without having to read or understand [http://www.rfc3261.net the +1200 RFC documents] behind it. 

''If you read them all some antidepressant and desintoxication is recommended after this effort.''

== Software repository ==

Besides the Python software library the software contains ready to use test scripts for:

  * [http://www.ietf.org/rfc/rfc3903.txt Publishing] and [http://www.ietf.org/rfc/rfc3265.txt subscribing] to SIP events like [http://www.ietf.org/rfc/rfc3856.txt presence], xcap-diff, [http://www.ietf.org/rfc/rfc3857.txt watcher-info], conference, [http://www.ietf.org/rfc/rfc3842.txt message-summary]

  * Lookup of SIP buddies using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast), [http://www.ietf.org/rfc/rfc3263.txt RFC 3263] (Locating SIP Services), ENUM (E.164 telephone numbers) and DHT (structured P2P overlays)

  * Managing full or partial XCAP documents like [http://www.tools.ietf.org/html/rfc5025 pres-rules], [http://www.tools.ietf.org/html/rfc4826 resource-lists] and [http://www.tools.ietf.org/html/rfc4827 pidf-manipulation]

  * Setting up SIP [http://tools.ietf.org/html/rfc4975 MSRP sessions] between end-points with public IP or behind NAT

  * Setting up [http://www.tech-invite.com/SIPWGs/03-WG-SIMPLE/Drafts/draft-ietf-simple-chat-02.txt ad-hoc multi-party chat sessions] with an MSRP chat server

  * Setting up VoIP sessions between end-points with public IP adresses or behind NAT

Using these scripts is easy to prototype Presence, IM and VoIP services based on the SIP protocol.

== Download  == 

The software can be downloaded from:

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

== End-user experiences ==

Using this toolkit you can develop in short time a skinable and cross-platform SIP User Agent that can be used for real-time Internet communications:

  * VoIP calls using Internet codecs (Speex, iLBC)

  * Presence using SIP SIMPLE (PUBLISH method and XCAP policy)

  * Interactive Messaging (IM) and File transfer using MSRP protocol

  * Multiparty chat using MSRP chat server

  * Support for NAT traversal using ICE for RTP media and MSRP Relay for IM

  * Sharing desktop screen using VLC protocol

  * Video calls

The software is tested against the most popular SIP server software: [http://openser.org OpenSER], [http://openxcap.org OpenXCAP], [http://mediaproxy-ng.org MediaProxy] and [http://msrprelay.org MSRPRelay] servers. 

== Integration with third-party projects ==

PyPjUA will be integrated into [http://tribler.org Tribler]. Tribler is an application that enables its users to find, enjoy and share content. PyPjUA will provides the real-time communication allowing user to interact in real time with each other using voice or text messaging.

== Developer program ==

To become an active developer to this program please send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com]

== Support == 

The software is developed and supported by [http://ag-projects.com AG Projects].