skl-graph 2023.13

SKeLeton Graph

Installation

This project is published on the Python Package Index (PyPI) at: https://pypi.org/project/skl-graph/. It should be installable from Python distribution platforms or Integrated Development Environments (IDEs). Otherwise, it can be installed from a command console:

• For all users, after acquiring administrative rights:

  • First installation: pip install skl-graph

  • Installation update: pip install --upgrade skl-graph

• For the current user (no administrative rights required):

  • First installation: pip install --user skl-graph

  • Installation update: pip install --user --upgrade skl-graph

Documentation

SKLGraph Pipeline: 2-D/3-D Object Map -> Object Skeleton -> SKeLeton Graph -> Graph Features

The documentation is available through a crude, automatically generated, index page at https://edebreuv.gitlabpages.inria.fr/SKLGraph/.

Note

In the context of this project, pdoc3 appears to be better at formatting the modules and functions documentation, but does not provide inter-module navigation, while pydoctor fails to correctly format certain documentation aspects, but offers structured, inter-module navigation (look for the index link in the pydoctor section).

Acknowledgments

The project is developed with PyCharm Community.

The development relies on several open-source packages (see install_requires in setup.py, if present; otherwise import statements should be searched for).

The code is formatted by Black, The Uncompromising Code Formatter.

The imports are ordered by isort… your imports, so you don’t have to.

The API documentations are automatically generated by:

• pdoc3, Auto-generate API documentation for Python projects.

• pydoctor, an API documentation generator that works by static analysis.