1. Logilab
  2. Untitled project
  3. logilab-common


Logilab's common library


This is only a mirror of the official project page at http://www.logilab.org/project/logilab-common

What's this ?

This package contains some modules used by differents Logilab's projects.

It is released under the GNU Lesser General Public License.


Designed to ease:

  • handling command line options and configuration files
  • writing interactive command line tools
  • manipulation of files and character strings
  • generating text and HTML reports
  • accessing some external libraries such as OmniORB, Pyro...
  • more...


Extract the tarball, jump into the created directory and run

python setup.py install

For installation options, see

python setup.py install --help

Provided modules

Here is a brief description of the available modules.

Modules providing high-level features

  • dbf, read Visual Fox Pro DBF files.
  • proc, interface to Linux /proc.
  • umessage, unicode email support.

Modules providing low-level functions and structures

  • date, a set of date manipulation functions.
  • decorators, function decorators such as cached, timed...
  • fileutils, some file / file path manipulation utilities.
  • modutils, python module manipulation functions.
  • tasksqueue, a prioritized tasks queue implementation.
  • textutils, some text manipulation functions (ansi colorization, line wrapping, rest support...).
  • visitor, a generic visitor pattern implementation.

Modules extending some standard modules

  • debugger, pdb customization.
  • xmlrpcutils, auth support for XML-RPC

Modules extending some external modules

  • hg, some Mercurial utility functions.
  • pyro_ext, some Pyro utility functions.
  • sphinx_ext, Sphinx plugin defining a autodocstring directive.
  • vcgutils , utilities functions to generate file readable with Georg Sander's vcg tool (Visualization of Compiler Graphs).

To be deprecated modules

Those logilab.common modules will much probably be deprecated in future versions:

  • testlib: use unittest2 instead
  • pytest: use discover instead
  • interface: use zope.interface if you really want this
  • table, xmlutils: is that used?
  • sphinxutils: we won't go that way imo (i == syt)

Deprecated modules


  • optparser: use clcommands instead
  • adbh, db, sqlgen: see logilab.database instead
  • contexts: content move to shellutils
  • html: deprecated without replacement

Comments, support, bug reports

Project page http://www.logilab.org/project/logilab-common

Use the python-projects@lists.logilab.org mailing list. Since we do not have publicly available bug tracker yet, bug reports should be emailed there too.

You can subscribe to this mailing list at http://lists.logilab.org/mailman/listinfo/python-projects

Archives are available at http://lists.logilab.org/pipermail/python-projects/