Source Code for Package orm2

 1  #!/usr/bin/env python 
 2  # -*- coding: iso-8859-1 -*- 
 3   
 4  ##  This file is part of orm, The Object Relational Membrane Version 2. 
 5  ## 
 6  ##  Copyright 2002-2006 by Diedrich Vorberg <diedrich@tux4web.de> 
 7  ## 
 8  ##  All Rights Reserved 
 9  ## 
10  ##  For more Information on orm see the README file. 
11  ## 
12  ##  This program is free software; you can redistribute it and/or modify 
13  ##  it under the terms of the GNU General Public License as published by 
14  ##  the Free Software Foundation; either version 2 of the License, or 
15  ##  (at your option) any later version. 
16  ## 
17  ##  This program is distributed in the hope that it will be useful, 
18  ##  but WITHOUT ANY WARRANTY; without even the implied warranty of 
19  ##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
20  ##  GNU General Public License for more details. 
21  ## 
22  ##  You should have received a copy of the GNU General Public License 
23  ##  along with this program; if not, write to the Free Software 
24  ##  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
25  ## 
26  ##  I have added a copy of the GPL in the file gpl.txt. 
27   
28  """ 
29  U{Savannah page (actual homepage)<https://savannah.nongnu.org/projects/orm/>} 
30   
31  Welcome to The Object Relational Membrane (v.2) 
32  =============================================== 
33   
34   I{For a general introduction please refer to the U{README<http://cvs.savannah.nongnu.org/viewcvs/*checkout*/orm2/README?root=orm>} file in the 
35   distribution root folder!} 
36   
37   To get started with orm you might want to look at the 
38   L{orm2.datatypes} module first to find out what datatypes are there 
39   to populate your dbclasses with. Knowing a little SQL this should be 
40   pretty much self-explaining. Next, check out the 
41   L{orm2.relationships} module to see how you can interrelate your 
42   classes. The L{orm2.dbobject.dbobject} class has a couple of 
43   interesting properties, though you might not want to fiddle with most 
44   of it at the beginning. The L{orm2.adapters} module contains code for 
45   interfacing with the RDBMS, though the L{orm2.datasource.datasource} 
46   may likely be everything you need. 
47   
48   To further study the intricacies of orm you might want to have a look 
49   at the L{orm2.sql} module, which handles SQL code generation and is 
50   going to be very helpful in writing advanced code. Consider using and/or 
51   interfacing with L{orm2.debug} to help you track down my and your 
52   errors. L{orm2.util} contains miscellaneous classes and functions 
53   that might come in handy. 
54   
55   The L{orm2.ui} module is practically not there, yet, but you might be 
56   interested anyway. 
57   
58   Any ideas, suggestion or criticism is always welcome! 
59   
60   Diedrich Vorberg <U{diedrich@tux4web.de}> 
61    
62  """ 
63   
64   
65   
66  # Local variables: 
67  # mode: python 
68  # ispell-local-dictionary: "english" 
69  # End: 
70