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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for logilab-common-1.9.4.tar.gz
Algorithm Hash digest
SHA256 1520016b97d55f196e75920897db65e87229f8cb79eda65b694010c0c11efa22
MD5 0e6bd1dfd0ecef6169614acc70a6a0c0
BLAKE2b-256 ff54010e182af9774ca6a365a16811aa1ea1df1a6cbe6368e381e3768ff6af45

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for logilab_common-1.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 efc7d460c96aae065eaa7fc45891fec0d7d023bc9502cb7757e0282a1da28c8e
MD5 9874f087cb952ee6d233ea04a3b3bdd4
BLAKE2b-256 002e61aa47bc2fb605155852277082324088ad3148e1ed0895ef49fb38f80cb6

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