summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAlexandre Fayolle <alexandre.fayolle@logilab.fr>2008-05-01 18:07:52 +0200
committerAlexandre Fayolle <alexandre.fayolle@logilab.fr>2008-05-01 18:07:52 +0200
commit904d11f3f7e8cc158c97eae1a6b6399821dd69be (patch)
tree03e15f7c8996993d77c15071a6a542753a16ee82 /README
parent2ab6082298757ba8f28af31be2913b13ba5efc80 (diff)
downloadlogilab-common-904d11f3f7e8cc158c97eae1a6b6399821dd69be.tar.gz
updated descriptions
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 32 insertions, 26 deletions
diff --git a/README b/README
index 6cc6e5d..0706c1e 100644
--- a/README
+++ b/README
@@ -31,12 +31,14 @@ Provided modules
Here is a brief description of the available modules :
* adbh.py:
- XXX
+ helper functions for using database advanced. Supported RDBMS
+include PostgreSQL, MySQL and sqlite. See also db.py.
* astutils:
- Some utilities function to manipulate Python's AST.
+ Deprecated module. Use logilab.astng.
* bind.py :
+ Deprecated module.
Provides a way to optimize globals in certain functions by binding
their names to values provided in a dictionnary.
@@ -44,18 +46,19 @@ Here is a brief description of the available modules :
A cache implementation with a least recently used algorithm.
* clcommands.py:
- XXX
+ helper functions for command line programs handling different
+ subcommands
* cli.py :
- Command line interface helper classes.
+ Command line interface helper classes (for interactive programs
+ using the command line)
* compat.py:
Transparent compatibility layer between different python version
- (actually 2.2 vs 2.3 for now)
* configuration.py :
Two mix-in classes to handle configuration from both command line
- (using optik) and configuration file.
+ (using optik/optparse) and configuration file.
* corbautils.py:
Usefull functions for use with the OmniORB CORBA library.
@@ -64,68 +67,70 @@ Here is a brief description of the available modules :
A daemon mix-in class.
* date.py:
- XXX
+ date manipulation helper functions
* db.py :
- A generic method to get a database connection.
+ A generic method to get a database connection. See also adbh.py.
* debugger.py:
- XXX
+ pdb customization
* decorators.py:
- XXX
+ useful decorators (cached, timed...)
* deprecation.py:
- XXX
+ mark functions / classes as deprecated or moved
* fileutils.py :
Some file / file path manipulation utilities.
* graph.py:
- XXX
+ graph manipulations, dot file generation
* html.py :
+ Deprecated module
Return an html formatted traceback from python exception infos.
* interface.py
Bases class for interfaces.
* logger.py :
+ Deprecated module : use logging from stdlib.
Define a logger interface and two concrete loggers : one which prints
everything on stdout, the other using syslog.
* logging_ext.py:
- XXX
+ extensions to stdlib's logging module
* logservice.py:
- XXX
+ Deprecated module. Use logging from stdlib.
* modutils.py :
Module manipulation utilities.
* monclient.py:
- XXX
+ Deprecated module
* monserver.py:
- XXX
+ Deprecated module
* optik_ext :
Add an abstraction level to transparently import optik classes from
optparse (python >= 2.3) or the optik package. It also defines two
- new option types : regexp and csv.
+ new option types (regexp, csv, color, date...)
* optparser.py:
- XXX
+ extend optparse's OptionParser to support commands
* patricia.py :
A Python implementation of PATRICIA trie (Practical Algorithm to
Retrieve Information Coded in Alphanumeric).
* pdf_ext.py:
- XXX
+ pdf and fdf file manipulations, with pdftk.
-* pytext.py:
- XXX
+* pytest.py:
+ unittest runner. See testlib
* shellutils.py:
Some utilities to replace shell scripts with python scripts.
@@ -134,20 +139,21 @@ Here is a brief description of the available modules :
Helper class to generate SQL strings to use with python's DB-API.
* table.py:
- XXX
+ manage tabular data (supports column and row names, sorting, grouping...
* testlib.py :
Generic tests execution methods.
* textutils.py:
- Some text manipulation utilities.
+ Some text manipulation utilities (ansi colorization, line wrapping,
+ rest support...)
* tree.py :
Base class to represent tree structure, and some others to make it
works with the visitor implementation (see below).
* umessage.py:
- XXX
+ unicode email support
* ureports:
Provides a way to create simple reports using python objects
@@ -167,13 +173,13 @@ Here is a brief description of the available modules :
are not twisted plugins in any package directory of your application.
* xmlrpcutils.py:
- XXX
+ Auth support for XML RPC
Comments, support, bug reports
------------------------------
Use the python-projects@logilab.org mailing list. Since we do not have
publicly available bug tracker yet, bug reports should be emailed
-there too.
+there too.
You can subscribe to this mailing list at
http://www.logilab.org/mailinglists/python_projects/mailinglist_register_form