2 .\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.

     2 .\" Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.

     6 .TH logilab-common 3 "30 Apr 2009"

     6 .TH logilab-common 3 "30 Jul 2012" "logilab-common 0.58.2"

    19 A brief description of the available modules :

    19 A brief description of the available modules:

    22 * adbh.py:

    22 .SH Modules providing high-level features

    23 helper functions for using database advanced. Supported RDBMS

    24 include PostgreSQL, MySQL and sqlite. See also db.py. 

    27 * astutils:

    25 * `cache`, a cache implementation with a least recently used algorithm.

    28 Deprecated module. Use logilab.astng. 

    31 * bind.py :

    28 * `changelog`, a tiny library to manipulate our simplified ChangeLog file format.

    32 Deprecated module. 

    33 Provides a way to optimize globals in certain functions by binding

    34 their names to values provided in a dictionnary.

    37 * cache.py :

    31 * `clcommands`, high-level classes to define command line programs handling different subcommands. It is based on `configuration` to get easy command line / configuration file handling.

    38 A cache implementation with a least recently used algorithm.

    41 * clcommands.py:

    34 * `cli`, a base class for interactive programs using the command line.

    42 helper functions for command line programs handling different

    43 subcommands

    46 * cli.py :

    37 * `configuration`, some classes to handle unified configuration from both command line (using optparse) and configuration file (using ConfigParser).

    47 Command line interface helper classes (for interactive programs

    48 using the command line)

    51 * compat.py: 

    40 * `dbf`, read Visual Fox Pro DBF files.

    52 Transparent compatibility layer between different python version

    55 * configuration.py :

    43 * `proc`, interface to Linux /proc.

    56 Two mix-in classes to handle configuration from both command line 

    57 (using optik/optparse) and configuration file.

    60 * corbautils.py:

    46 * `umessage`, unicode email support.

    61 Usefull functions for use with the OmniORB CORBA library.

    64 * daemon.py :

    49 * `ureports`, micro-reports, a way to create simple reports using python objects without care of the final formatting. ReST and html formatters are provided.

    65 A daemon mix-in class.

    68 * date.py:

    52 .SH Modules providing low-level functions and structures

    69 date manipulation helper functions

    72 * db.py :

    55 * `compat`, provides a transparent compatibility layer between different python versions.

    73 A generic method to get a database connection. See also adbh.py.

    76 * debugger.py:

    58 * `date`, a set of date manipulation functions.

    77 pdb customization

    80 * decorators.py:

    61 * `daemon`, a daemon function and mix-in class to properly start an Unix daemon process.

    81 useful decorators (cached, timed...)

    84 * deprecation.py:

    64 * `decorators`, function decorators such as cached, timed...

    85 mark functions / classes as deprecated or moved

    88 * fileutils.py :

    67 * `deprecation`, decorator, metaclass & all to mark functions / classes as deprecated or moved

    89 Some file / file path manipulation utilities.

    92 * graph.py:

    70 * `fileutils`, some file / file path manipulation utilities.

    93 graph manipulations, dot file generation

    96 * html.py :

    73 * `graph`, graph manipulations functions such as cycle detection, bases for dot file generation.

    97 Deprecated module

    98 Return an html formatted traceback from python exception infos.

   101 * interface.py

    76 * `modutils`, python module manipulation functions.

   102 Bases class for interfaces.

   105 * logger.py :

    79 * `shellutils`, some powerful shell like functions to replace shell scripts with python scripts.

   106 Deprecated module : use logging from stdlib. 

   107 Define a logger interface and two concrete loggers : one which prints

   108 everything on stdout, the other using syslog.

   111 * logging_ext.py:

    82 * `tasksqueue`, a prioritized tasks queue implementation.

   112 extensions to stdlib's logging module

   115 * logservice.py:

    85 * `textutils`, some text manipulation functions (ansi colorization, line wrapping, rest support...).

   116 Deprecated module. Use logging from stdlib. 

   119 * modutils.py :

    88 * `tree`, base class to represent tree structure, and some others to make it works with the visitor implementation (see below).

   120 Module manipulation utilities.

   123 * monclient.py:

    91 * `visitor`, a generic visitor pattern implementation.

   124 Deprecated module

   127 * monserver.py:

    94 

   128 Deprecated module

    95 .SH Modules extending some standard modules

   131 * optik_ext :

    98 * `debugger`,  `pdb` customization.

   132 Add an abstraction level to transparently import optik classes from

   133 optparse (python >= 2.3) or the optik package. It also defines two

   134 new option types (regexp, csv, color, date...)

   137 * optparser.py:

   101 * `logging_ext`, extensions to `logging` module such as a colorized formatter and an easier initialization function.

   138 extend optparse's OptionParser to support commands 

   141 * patricia.py :

   104 * `optik_ext`, defines some new option types (regexp, csv, color, date, etc.) for `optik` / `optparse`

   142 A Python implementation of PATRICIA trie (Practical Algorithm to

   143 Retrieve Information Coded in Alphanumeric).

   146 * pdf_ext.py:

   107 * `xmlrpcutils`, auth support for XML-RPC

   147 pdf and fdf file manipulations, with pdftk. 

   150 * pytest.py:

   110 

   151 unittest runner. See testlib

   111 .SH Modules extending some external modules

   154 * shellutils.py:

   114 * `corbautils`, useful functions for use with the OmniORB_ CORBA library.

   155 Some utilities to replace shell scripts with python scripts.

   158 * sqlgen.py :

   117 * `hg`, some Mercurial_ utility functions.

   159 Helper class to generate SQL strings to use with python's DB-API.

   162 * table.py:

   120 * `pdf_ext`, pdf and fdf file manipulations, with pdftk.

   163 manage tabular data (supports column and row names, sorting, grouping...

   166 * testlib.py :

   123 * `pyro_ext`, some Pyro_ utility functions.

   167 Generic tests execution methods.

   170 * textutils.py:

   126 * `sphinx_ext`, Sphinx_ plugin defining a `autodocstring` directive.

   171 Some text manipulation utilities (ansi colorization, line wrapping,

   172 rest support...)

   175 * tree.py :

   129 * `vcgutils` , utilities functions to generate file readable with Georg Sander's vcg tool (Visualization of Compiler Graphs).

   176 Base class to represent tree structure, and some others to make it

   177 works with the visitor implementation (see below).

   180 * umessage.py:

   132 

   181 unicode email support

   133 .SH To be deprecated modules

   184 * ureports:

   136 These `logilab.common` modules will probably be deprecated in future versions:

   185 Provides a way to create simple reports using python objects

   186 without care of the final formatting. Some formatters text and html

   187 are provided.

   190 * vcgutils.py :

   139 * `testlib`: use `unittest2`_ instead

   191 utilities functions to generate file readable with Georg Sander's vcg

   140 .LP

   192 (Visualization of Compiler Graphs).

   141 * `pytest`: use `discover`_ instead

   142 .LP

   143 * `interface`: use `zope.interface`_ if you really want this

   144 .LP

   145 * `table`, `xmlutils`: is that used?

   146 .LP

   147 * `sphinxutils`: we won't go that way imo (i == syt)

   195 * visitor.py :

   150 

   196 A generic visitor pattern implementation.

   151 .SH Deprecated modules

   199 * twisted_distutils.py

   154 These `logilab.common` modules are only for backward compatibility. They can go away at anytime.

   200 This module enables the installation of plugins.tml files using standard

   201 distutils syntax. Note that you can use this to install files that

   202 are not twisted plugins in any package directory of your application.

   205 * xmlrpcutils.py:

   157 * `optparser`: use `clcommands` instead

   206 Auth support for XML RPC

   158 .LP

   159 

   160 * `adbh`, `db`, `sqlgen`: see `logilab.database`_ instead

   161 .LP

   162 

   163 * `contexts`: content move to `shellutils`

   164 .LP

   165 

   166 * `html`: deprecated without replacement

   213 shared object library files

   173 logilab-common python modules 

   174 .TP

   175 .B /usr/lib/python2.7/vendor-packages/logilab/common

   176 logilab-common python modules

   219 [email protected]

   182 Use the [email protected] mailing list. Since we do not have

   183 publicly available bug tracker yet, bug reports should be emailed

   184 there too.

   185 .LP

   186 

   187 You can subscribe to this mailing list at

   188 http://lists.logilab.org/mailman/listinfo/python-projects

   189 .LP

   190 

   191 Archives are available at

   192 http://lists.logilab.org/pipermail/python-projects/

   193 

   194 .LP