chiark - git - mdw - python-cdb/blob - README

   1 python-cdb 0.32
   2 MJ Pomraning <mjp@pilcrow.madison.wi.us>
   3 26 Jan 2002
   4
   5 INTRO
   6 =====
   7 The python-cdb extension module is an adaptation of D. J. Bernstein's
   8 constant database package (see http://cr.yp.to/cdb.html).
   9
  10 cdb files are mappings of keys to values, designed for wickedly
  11 fast lookups and atomic updates.  This module mimics the normal
  12 cdb utilities, cdb(get|dump|make), via convenient, high-level Python
  13 objects.
  14
  15
  16 COPYRIGHT
  17 =========
  18 python-cdb is free software, as is cdb itself.
  19
  20 The extension module is licensed under the GNU GPL version 2 or later,
  21 and is copyright 2001, 2002 Michael J. Pomraning.  Ancillary files from
  22 Felix von Leitner's libowfat are also licensed under the GPL.  Finally,
  23 modifications to D. J. Bernstein's public domain cdb implementation are
  24 similarly released to the public domain.
  25
  26
  27 INSTALL
  28 =======
  29
  30   $ tar zxf python-cdb-$VERSION.tgz
  31   $ cd python-cdb-$VERSION
  32   $ python setup.py build
  33   $ python setup.py install
  34   # python setup.py bdist --format=rpm, if you prefer
  35
  36 Now break it and tell me about it (or use it smoothly and tell me
  37 about that, too).
  38
  39 DOCS
  40 ====
  41 Consult the docstrings for module, class, and function documentation.
  42
  43   $ python -c 'import cdb; print cdb.__doc__'
  44   $ python -c 'import cdb; print cdb.cdbmake("f.cdb","f.tmp").__doc__'
  45   $ python -c 'import cdb; print cdb.init("some.cdb").__doc__'
  46
  47 BUGS
  48 ====
  49 Bug reports to MJ Pomraning <mjp@pilcrow.madison.wi.us>.
  50
  51
  52 TODO
  53 ====
  54
  55   - better README/docs
  56
  57   - API features new with 2.2
  58
  59   - formal speed benchmarks
  60
  61   - fix bugs, maybe :)
  62
  63