| OLD | NEW |
| (Empty) | |
| 1 Metadata-Version: 1.0 |
| 2 Name: logilab-common |
| 3 Version: 0.58.1 |
| 4 Summary: collection of low-level Python packages and modules used by Logilab pro
jects |
| 5 Home-page: http://www.logilab.org/project/logilab-common |
| 6 Author: Logilab |
| 7 Author-email: contact@logilab.fr |
| 8 License: LGPL |
| 9 Description: Logilab's common library |
| 10 ======================== |
| 11 |
| 12 What's this ? |
| 13 ------------- |
| 14 |
| 15 This package contains some modules used by differents Logilab's projects
. |
| 16 |
| 17 It is released under the GNU Lesser General Public License. |
| 18 |
| 19 There is no documentation available yet but the source code should be cl
ean and |
| 20 well documented. |
| 21 |
| 22 Designed to ease: |
| 23 |
| 24 * handling command line options and configuration files |
| 25 * writing interactive command line tools |
| 26 * manipulation of files and character strings |
| 27 * manipulation of common structures such as graph, tree, and pattern suc
h as visitor |
| 28 * generating text and HTML reports |
| 29 * accessing some external libraries such as OmniORB_, Pyro_... |
| 30 * more... |
| 31 |
| 32 |
| 33 Installation |
| 34 ------------ |
| 35 |
| 36 Extract the tarball, jump into the created directory and run :: |
| 37 |
| 38 python setup.py install |
| 39 |
| 40 For installation options, see :: |
| 41 |
| 42 python setup.py install --help |
| 43 |
| 44 |
| 45 Provided modules |
| 46 ---------------- |
| 47 |
| 48 Here is a brief description of the available modules. |
| 49 |
| 50 Modules providing high-level features |
| 51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 52 |
| 53 * `cache`, a cache implementation with a least recently used algorithm. |
| 54 |
| 55 * `changelog`, a tiny library to manipulate our simplified ChangeLog fil
e format. |
| 56 |
| 57 * `clcommands`, high-level classes to define command line programs handl
ing |
| 58 different subcommands. It is based on `configuration` to get easy comm
and line |
| 59 / configuration file handling. |
| 60 |
| 61 * `cli`, a base class for interactive programs using the command line. |
| 62 |
| 63 * `configuration`, some classes to handle unified configuration from bot
h |
| 64 command line (using optparse) and configuration file (using ConfigPars
er). |
| 65 |
| 66 * `dbf`, read Visual Fox Pro DBF files. |
| 67 |
| 68 * `proc`, interface to Linux /proc. |
| 69 |
| 70 * `umessage`, unicode email support. |
| 71 |
| 72 * `ureports`, micro-reports, a way to create simple reports using python
objects |
| 73 without care of the final formatting. ReST and html formatters are pro
vided. |
| 74 |
| 75 |
| 76 Modules providing low-level functions and structures |
| 77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 78 |
| 79 * `compat`, provides a transparent compatibility layer between different
python |
| 80 versions. |
| 81 |
| 82 * `date`, a set of date manipulation functions. |
| 83 |
| 84 * `daemon`, a daemon function and mix-in class to properly start an Unix
daemon |
| 85 process. |
| 86 |
| 87 * `decorators`, function decorators such as cached, timed... |
| 88 |
| 89 * `deprecation`, decorator, metaclass & all to mark functions / classes
as |
| 90 deprecated or moved |
| 91 |
| 92 * `fileutils`, some file / file path manipulation utilities. |
| 93 |
| 94 * `graph`, graph manipulations functions such as cycle detection, bases
for dot |
| 95 file generation. |
| 96 |
| 97 * `modutils`, python module manipulation functions. |
| 98 |
| 99 * `shellutils`, some powerful shell like functions to replace shell scri
pts with |
| 100 python scripts. |
| 101 |
| 102 * `tasksqueue`, a prioritized tasks queue implementation. |
| 103 |
| 104 * `textutils`, some text manipulation functions (ansi colorization, line
wrapping, |
| 105 rest support...). |
| 106 |
| 107 * `tree`, base class to represent tree structure, and some others to mak
e it |
| 108 works with the visitor implementation (see below). |
| 109 |
| 110 * `visitor`, a generic visitor pattern implementation. |
| 111 |
| 112 |
| 113 Modules extending some standard modules |
| 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 115 |
| 116 * `debugger`, `pdb` customization. |
| 117 |
| 118 * `logging_ext`, extensions to `logging` module such as a colorized form
atter |
| 119 and an easier initialization function. |
| 120 |
| 121 * `optik_ext`, defines some new option types (regexp, csv, color, date,
etc.) |
| 122 for `optik` / `optparse` |
| 123 |
| 124 * `xmlrpcutils`, auth support for XML-RPC |
| 125 |
| 126 |
| 127 Modules extending some external modules |
| 128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 129 |
| 130 * `corbautils`, useful functions for use with the OmniORB_ CORBA library
. |
| 131 |
| 132 * `hg`, some Mercurial_ utility functions. |
| 133 |
| 134 * `pdf_ext`, pdf and fdf file manipulations, with pdftk. |
| 135 |
| 136 * `pyro_ext`, some Pyro_ utility functions. |
| 137 |
| 138 * `sphinx_ext`, Sphinx_ plugin defining a `autodocstring` directive. |
| 139 |
| 140 * `vcgutils` , utilities functions to generate file readable with Georg
Sander's |
| 141 vcg tool (Visualization of Compiler Graphs). |
| 142 |
| 143 |
| 144 To be deprecated modules |
| 145 ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 146 |
| 147 Those `logilab.common` modules will much probably be deprecated in futur
e |
| 148 versions: |
| 149 |
| 150 * `testlib`: use `unittest2`_ instead |
| 151 * `pytest`: use `discover`_ instead |
| 152 * `interface`: use `zope.interface`_ if you really want this |
| 153 * `table`, `xmlutils`: is that used? |
| 154 * `sphinxutils`: we won't go that way imo (i == syt) |
| 155 |
| 156 |
| 157 Deprecated modules |
| 158 ~~~~~~~~~~~~~~~~~~ |
| 159 |
| 160 Those `logilab.common` modules are only there for backward compatibility
. They |
| 161 can go away at anytime. |
| 162 |
| 163 * `optparser`: use `clcommands` instead |
| 164 |
| 165 * `adbh`, `db`, `sqlgen`: see `logilab.database`_ instead |
| 166 |
| 167 * `contexts`: content move to `shellutils` |
| 168 |
| 169 * `html`: deprecated without replacement |
| 170 |
| 171 |
| 172 Comments, support, bug reports |
| 173 ------------------------------ |
| 174 |
| 175 Project page http://www.logilab.org/project/logilab-common |
| 176 |
| 177 Use the python-projects@lists.logilab.org mailing list. Since we do not
have |
| 178 publicly available bug tracker yet, bug reports should be emailed |
| 179 there too. |
| 180 |
| 181 You can subscribe to this mailing list at |
| 182 http://lists.logilab.org/mailman/listinfo/python-projects |
| 183 |
| 184 Archives are available at |
| 185 http://lists.logilab.org/pipermail/python-projects/ |
| 186 |
| 187 |
| 188 .. _Pyro: http://pyro.sourceforge.net/ |
| 189 .. _OmniORB: http://omniorb.sourceforge.net/ |
| 190 .. _Mercurial: http://mercurial.selenic.com |
| 191 .. _Sphinx: http://sphinx.pocoo.org/ |
| 192 .. _`logilab.database`: http://www.logilab.org/project/logilab-database/ |
| 193 .. _`unittest2`: http://pypi.python.org/pypi/unittest2 |
| 194 .. _`discover`: http://pypi.python.org/pypi/discover |
| 195 .. _`zope.interface`: http://pypi.python.org/pypi/zope.interface |
| 196 |
| 197 Platform: UNKNOWN |
| 198 Classifier: Topic :: Utilities |
| 199 Classifier: Programming Language :: Python |
| 200 Classifier: Programming Language :: Python :: 2 |
| 201 Classifier: Programming Language :: Python :: 3 |
| OLD | NEW |