--- projects/pystatgrab/README 2004/03/20 19:25:02 1.1 +++ projects/pystatgrab/README 2005/04/14 17:19:11 1.4 @@ -1,7 +1,30 @@ pystatgrab README -http://www.i-scream.org/libstatgrab/ +http://www.i-scream.org/pystatgrab/ -$Id: README,v 1.1 2004/03/20 19:25:02 tdb Exp $ +$Id: README,v 1.4 2005/04/14 17:19:11 tdb Exp $ pystatgrab contains python bindings for libstatgrab. For information on libstatgrab see the libstatgrab website given above. + +There is currently very little documentation for pystatgrab. +Installation is a normal distutils setup: + +./setup.py install + +If the installer has problems finding libstatgrab you may need to set +PKG_CONFIG_PATH to /lib/pkgconfig - where prefix is the prefix +you used when installing libstatgrab (default is /usr/local). + +The functions available through pystatgrab directly match those of +the libstatgrab functions. Documentation on those functions can be +found in the libstatgrab package, or on the libstatgrab website. + +The return types of the functions are dictionaries, sometimes +contained within an array if more than one item is being returned. +These map pretty much directly on to the C structures returned by +libstatgrab. + +Please let us know if you have any problems - support@i-scream.org. + +If you find a bug, help us to fix it by sending details to +bugs@i-scream.org. If you have a patch, please send it too.