diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..643579f --- /dev/null +++ b/README.rst @@ -0,0 +1,78 @@ +Logilab's common library +======================== + +What's this ? +------------- + +This package contains some modules used by different Logilab projects. + +It is released under the GNU Lesser General Public License. + +There is no documentation available yet but the source code should be clean and +well documented. + +Designed to ease: + +* handling command line options and configuration files +* writing interactive command line tools +* manipulation of files and character strings +* manipulation of common structures such as graph, tree, and pattern such as visitor +* generating text and HTML reports +* more... + +Documentation +------------- + +Documentation is available at https://logilab-common.readthedocs.io/ + +Installation +------------ + +logilab-common is available on pypi so you can install it using pip :: + + pip install logilab-common + +Or alternatively extract the tarball, jump into the created directory and run :: + + python setup.py install + +For installation options, see :: + + python setup.py install --help + + +Building the documentation +-------------------------- + +Create a virtualenv and install dependencies :: + + virtualenv venv + source venv/bin/activate + + # you need the krb5-config command to build all dependencies + # on debian you can get it using "apt-get install libkrb5-dev" + + pip install doc/requirements-doc.txt + + # install logilab-common + pip install -e . + +Then build the doc :: + + cd doc + make html + +It's now available under `doc/_build/html/` + +Comments, support, bug reports +------------------------------ + +Project page https://www.logilab.org/project/logilab-common + +Use the cubicweb-devel at lists.cubicweb.org mailing list. + +You can subscribe to this mailing list at +https://lists.cubicweb.org/mailman/listinfo/cubicweb-devel + +Archives are available at +https://lists.cubicweb.org/pipermail/cubicweb-devel/ |