components/logilab-common/logilab-common.3

   1 .\"
   2 .\" Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" logilab-common.3
   5 .\"
   6 .TH logilab-common 3 "30 Jul 2012" "logilab-common 0.58.2"
   7 .SH NAME
   8 logilab-common \- Common Modules used by Logilab projects
   9 .SH DESCRIPTION
  10 The
  11 .I logilab-common
  12 package contains some modules used by different Logilab
  13 projects.
  14
  15 .LP
  16 .SH Provided modules
  17 .LP
  18
  19 A brief description of the available modules:
  20 .LP
  21
  22 .SH Modules providing high-level features
  23 .LP
  24
  25 * `cache`, a cache implementation with a least recently used algorithm.
  26 .LP
  27
  28 * `changelog`, a tiny library to manipulate our simplified ChangeLog file format.
  29 .LP
  30
  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.
  32 .LP
  33
  34 * `cli`, a base class for interactive programs using the command line.
  35 .LP
  36
  37 * `configuration`, some classes to handle unified configuration from both command line (using optparse) and configuration file (using ConfigParser).
  38 .LP
  39
  40 * `dbf`, read Visual Fox Pro DBF files.
  41 .LP
  42
  43 * `proc`, interface to Linux /proc.
  44 .LP
  45
  46 * `umessage`, unicode email support.
  47 .LP
  48
  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.
  50 .LP
  51
  52 .SH Modules providing low-level functions and structures
  53 .LP
  54
  55 * `compat`, provides a transparent compatibility layer between different python versions.
  56 .LP
  57
  58 * `date`, a set of date manipulation functions.
  59 .LP
  60
  61 * `daemon`, a daemon function and mix-in class to properly start an Unix daemon process.
  62 .LP
  63
  64 * `decorators`, function decorators such as cached, timed...
  65 .LP
  66
  67 * `deprecation`, decorator, metaclass & all to mark functions / classes as deprecated or moved
  68 .LP
  69
  70 * `fileutils`, some file / file path manipulation utilities.
  71 .LP
  72
  73 * `graph`, graph manipulations functions such as cycle detection, bases for dot file generation.
  74 .LP
  75
  76 * `modutils`, python module manipulation functions.
  77 .LP
  78
  79 * `shellutils`, some powerful shell like functions to replace shell scripts with python scripts.
  80 .LP
  81
  82 * `tasksqueue`, a prioritized tasks queue implementation.
  83 .LP
  84
  85 * `textutils`, some text manipulation functions (ansi colorization, line wrapping, rest support...).
  86 .LP
  87
  88 * `tree`, base class to represent tree structure, and some others to make it works with the visitor implementation (see below).
  89 .LP
  90
  91 * `visitor`, a generic visitor pattern implementation.
  92 .LP
  93
  94
  95 .SH Modules extending some standard modules
  96 .LP
  97
  98 * `debugger`,  `pdb` customization.
  99 .LP
 100
 101 * `logging_ext`, extensions to `logging` module such as a colorized formatter and an easier initialization function.
 102 .LP
 103
 104 * `optik_ext`, defines some new option types (regexp, csv, color, date, etc.) for `optik` / `optparse`
 105 .LP
 106
 107 * `xmlrpcutils`, auth support for XML-RPC
 108 .LP
 109
 110
 111 .SH Modules extending some external modules
 112 .LP
 113
 114 * `corbautils`, useful functions for use with the OmniORB_ CORBA library.
 115 .LP
 116
 117 * `hg`, some Mercurial_ utility functions.
 118 .LP
 119
 120 * `pdf_ext`, pdf and fdf file manipulations, with pdftk.
 121 .LP
 122
 123 * `pyro_ext`, some Pyro_ utility functions.
 124 .LP
 125
 126 * `sphinx_ext`, Sphinx_ plugin defining a `autodocstring` directive.
 127 .LP
 128
 129 * `vcgutils` , utilities functions to generate file readable with Georg Sander's vcg tool (Visualization of Compiler Graphs).
 130 .LP
 131
 132
 133 .SH To be deprecated modules
 134 .LP
 135
 136 These `logilab.common` modules will probably be deprecated in future versions:
 137 .LP
 138
 139 * `testlib`: use `unittest2`_ instead
 140 .LP
 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)
 148 .LP
 149
 150
 151 .SH Deprecated modules
 152 .LP
 153
 154 These `logilab.common` modules are only for backward compatibility. They can go away at anytime.
 155 .LP
 156
 157 * `optparser`: use `clcommands` instead
 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
 167
 168 .LP
 169
 170 .SH FILES
 171 .TP 2.2i
 172 .B /usr/lib/python2.6/vendor-packages/logilab/common
 173 logilab-common python modules
 174 .TP
 175 .B /usr/lib/python2.7/vendor-packages/logilab/common
 176 logilab-common python modules
 177
 178 .SH AUTHORS
 179 Sylvain Thenault (sylvain.thenault@logilab.fr)
 180
 181 .SH SUPPORT
 182 Use the python-projects@lists.logilab.org 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
 195
 196 .SH SEE ALSO
 197 .IR logilab-astng (3),
 198 .IR pylint (1)