Skip to main content

collection of low-level Python packages and modules used by Logilab projects

Project description

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/

Code style

The python code is verified against flake8 and formatted with black.

  • You can run tox -e black to check that the files are well formatted.

  • You can run tox -e black-run to format them if needed.

  • You can include the .hgrc to your own .hgrc to automatically run black before each commit/amend. This can be done by writing %include ../.hgrc at the end of your .hgrc.

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/

Project details


Release history Release notifications | RSS feed

This version

2.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logilab-common-2.0.0.tar.gz (187.5 kB view details)

Uploaded Source

Built Distribution

logilab_common-2.0.0-py3-none-any.whl (154.3 kB view details)

Uploaded Python 3

File details

Details for the file logilab-common-2.0.0.tar.gz.

File metadata

  • Download URL: logilab-common-2.0.0.tar.gz
  • Upload date:
  • Size: 187.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for logilab-common-2.0.0.tar.gz
Algorithm Hash digest
SHA256 a23bd1da4dd6a63e448f4392e7b2386855ff70615578bfcf993eeb8824de970b
MD5 36ead83430ad1f9cf87d9e8216fd74df
BLAKE2b-256 cac7875df9e513d29486557b495bc0260ec38f03b077f49a5d92de50bdf8ffce

See more details on using hashes here.

File details

Details for the file logilab_common-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for logilab_common-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb0bf558a5cd5d57ec4cc14fac04b481e3cca91c47ece6954985133638557af
MD5 2d58f8c06e2d70fadb8ce85a2b1b8ac0
BLAKE2b-256 085ece702b6f234ca4599a406d8c2bf8302b39a507ac9af28f7120364c2a073f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page