Installation#

Dependencies#

The planning package requires the following Python modules:

Name

Version

Summary

Python

>=3.8, <4

PyQt5

Python bindings for the Qt cross platform application toolkit

PyQtWebEngine

Python bindings for the Qt WebEngine framework

guidata

>=3.1

Automatic GUI generation for easy dataset editing and display

svgwrite

A Python library to create SVG drawings.

python-dateutil

Extensions to the standard Python datetime module

Optional modules for development:

Name

Version

Summary

black

The uncompromising code formatter.

isort

A Python utility / library to sort Python imports.

pylint

python code static checker

Coverage

Code coverage measurement for Python

Optional modules for building the documentation:

Name

Version

Summary

sphinx

>6

Python documentation generator

pydata_sphinx_theme

Bootstrap-based Sphinx theme from the PyData community

Note

Python 3.11 and PyQt5 are the reference for production release

How to install#

Wheel package:#

On any operating system, using pip and the Wheel package is the easiest way to install PyPlanning on an existing Python distribution:

$ pip install --upgrade PyPlanning-1.0.0-py2.py3-none-any.whl

Source package:#

Installing PyPlanning directly from the source package is straigthforward:

$ python -m build