Ticket #625: __init__.py

File __init__.py, 1.5 kB (added by ttressieres, 2 years ago)

init file of PyPerforce? patch

Line 
1 """A Python interface for the Perforce SCM
2
3 Sub Modules
4 ===========
5
6   L{perforce.api}
7   ---------------
8     Wrappers directly onto Perforce's C++ API.
9
10   L{perforce.async}
11   -----------------
12     Asynchronous interface to the Perforce Python API using Twisted.
13
14   L{perforce.connection}
15   ----------------------
16     Defines the Connection class for connecting to a Perforce server and
17     running commands on the connection.
18
19   L{perforce.forms}
20   -----------------
21     Module containing Perforce form related classes.
22
23   L{perforce.results}
24   -------------------
25     Module containing helper classes for processing output of Perforce
26     commands.
27
28   L{perforce.objects}
29   -------------------
30     Module containing object oriented interfaces for Perforce entities
31     such as branches, users, clients etc.
32     
33   L{perforce.tests}
34   -----------------
35     Unit tests for the Perforce Python API.
36 """
37
38 __version__   = '0.3'
39 __author__    = 'Lewis Baker'
40 __email__     = 'lewisbaker@users.sourceforge.net'
41 __copyright__ = '(c) 2005-2006 Maptek Pty. Ltd.'
42
43 __all__ = ['api', 'async', 'connection', 'forms', 'objects', 'results',
44            'CharSet', 'Message', 'PerforceError',
45            'Connection', 'ConnectionFailed', 'ConnectionDropped',
46            'Branch', 'Client', 'Label', 'User', 'Change', 'Job', 'CommandError']
47
48 from perforce.api import CharSet, Error as Message, PerforceError
49 from perforce.connection import Connection, ConnectionFailed, ConnectionDropped
50 from perforce.objects import Branch, Client, Label, User, Change, Counter, \
51   Job, CommandError