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.7

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

Uploaded Source

Built Distribution

logilab_common-1.9.7-py3-none-any.whl (173.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for logilab-common-1.9.7.tar.gz
Algorithm Hash digest
SHA256 fc994df5194844b6e2f532fd57a4a03ba75d3de2aa2f32b8d360ea90b051bb13
MD5 a11ba0da4c34cc25ce7e225b412a1f73
BLAKE2b-256 f599d0edc94e0742ca3423b48490c3905628239eec99f9b29d115ed7b578039a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for logilab_common-1.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7326d8f54a68f7aa6653ebed7a0e903a09d2d8790793165b96d27755aecfa2e3
MD5 7e6df49733b07fbd9c6b20561a03fc45
BLAKE2b-256 298a6176ae1e7ba7d885812f53ece8e99918c35a845000dffb9f3bbfb773c90a

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