Package Skype4Py
[frames] | no frames]

Source Code for Package Skype4Py

 1  # 
 2  # Skype4Py 
 3  # 
 4   
 5  ''' 
 6  Skype4Py is a multiplatform Skype API wrapper for Python. 
 7   
 8    1. Usage. 
 9   
10       C{Skype4Py} is the package that you should import in your scripts to be able to access Skype. 
11       You won't need to import any submodules. Everything you may need will be available at the 
12       package level. This includes: 
13   
14         - Classes 
15           - C{Skype4Py.Skype = L{Skype4Py.skype.ISkype}} 
16           - C{Skype4Py.CallChannelManager = L{Skype4Py.callchannel.ICallChannelManager}} 
17         - Constants 
18           - C{Skype4Py.* = L{Skype4Py.enums}.*} 
19         - Errors 
20           - C{Skype4Py.SkypeError = L{Skype4Py.errors.ISkypeError}} 
21           - C{Skype4Py.SkypeAPIError = L{Skype4Py.errors.ISkypeAPIError}} 
22   
23       The first two are the only classes that you will be instatinating directly. Calling their methods/properties 
24       will give you the access to instances of all other classes, you won't have to instatinate them yourself. 
25       The two classes are also the only ones that provide event handlers (see [3]). 
26   
27       Every Skype4Py script instatinates the C{Skype4Py.Skype} class at least once. That's what you want to do 
28       first in your script. Then follow the L{Skype4Py.skype.ISkype} reference to see where you can get from 
29       there. 
30   
31    2. Quick example. 
32   
33       This short example connects to Skype client and prints the user's full name and the names of all the 
34       contacts from the contacts list:: 
35   
36           import Skype4Py 
37   
38           # Create Skype instance 
39           skype = Skype4Py.Skype() 
40   
41           # Connect Skype object to Skype client 
42           skype.Attach() 
43   
44           print 'Your full name:', skype.CurrentUser.FullName 
45           print 'Your contacts:' 
46           for user in skype.Friends: 
47               print '    ', user.FullName 
48   
49  @author: U{Arkadiusz Wahlig<yak@nokix.pasjagsm.pl>} 
50  @requires: Python 2.4 or newer 
51  @see: U{The Skype4Py webpage<https://developer.skype.com/wiki/Skype4Py>} 
52  @license: BSD License (see the accompanying LICENSE file for more information) 
53  @copyright: S{copy} 2007 Arkadiusz Wahlig 
54  ''' 
55   
56  from skype import ISkype as Skype 
57  from callchannel import ICallChannelManager as CallChannelManager 
58  from errors import ISkypeError as SkypeError, ISkypeAPIError as SkypeAPIError 
59  from enums import * 
60   
61   
62  __version__ = '1.0.29.0' 
63  '''The version of Skype4Py.''' 
64