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

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-1.9.6.tar.gz (206.5 kB view details)

Uploaded Source

Built Distribution

logilab_common-1.9.6-py3-none-any.whl (172.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: logilab-common-1.9.6.tar.gz
  • Upload date:
  • Size: 206.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for logilab-common-1.9.6.tar.gz
Algorithm Hash digest
SHA256 1a5f20010eb9372da0aa3aad8f6af3e5eadd4026fcb95fa73c5e0a81dd995090
MD5 4f472e06faa632c00a3fe2279e34b93e
BLAKE2b-256 9677735a00a9342602a8ded338f48daad5b10d9b786b9a0d331c9176c70d14ad

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for logilab_common-1.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3a91437b16f20b5bfeb82376e1f136b345e7cf73dab70c64bd937e6f036d524c
MD5 0ae7dd3152a88357b75523b455d3c7d4
BLAKE2b-256 b93089753254620dd4f4f7c4da5ed911d75ba7abe69a65931a0beb740bb85d91

See more details on using hashes here.

Provenance

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