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

1.9.8

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

Uploaded Source

Built Distribution

logilab_common-1.9.8-py3-none-any.whl (173.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for logilab-common-1.9.8.tar.gz
Algorithm Hash digest
SHA256 f4a8d201b6f1eb46aa5367a3c3d274a50ec50d20f57d8ffa8d4bdea26edbfde7
MD5 4c831c90c4b0a105059892ee1160a0e0
BLAKE2b-256 0ee9799401d7785ebeeb7a0088c56ac59a870fcc7004294431bfd7f6c68d85ba

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for logilab_common-1.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 39543a5f3c06dd40236af214e6762f27553428483e8af30cdffd145764d41d00
MD5 5f90bf2659aa440191be4203941eab98
BLAKE2b-256 b226bff06c25b0b7f1d0995a86a39304f1881e00407348094a4db86bd6eaa510

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