comparison roundup/instance.py @ 4388:72db88cb68b0

doc tweak
author Richard Jones <richard@users.sourceforge.net>
date Mon, 12 Jul 2010 04:02:14 +0000
parents a0be2bc223f5
children b9eb72f20b4d
comparison
equal deleted inserted replaced
4387:a20d8c1c72cd 4388:72db88cb68b0
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" 14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, 15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 # 17 #
18 18
19 """Tracker handling (open tracker). 19 """Top-level tracker interface.
20 20
21 Backwards compatibility for the old-style "imported" trackers. 21 Open a tracker with:
22
23 >>> from roundup import instance
24 >>> db = instance.open('path to tracker home')
25
26 The "db" handle you get back is the tracker's hyperdb which has the interface
27 desciribed in `roundup.hyperdb.Database`.
22 """ 28 """
23 __docformat__ = 'restructuredtext' 29 __docformat__ = 'restructuredtext'
24 30
25 import os 31 import os
26 import sys 32 import sys

Roundup Issue Tracker: http://roundup-tracker.org/