Installation

The source code is entirely written in Python and can be installed either from PyPI or directly from the latest version on GitHub. Compatible Python versions (at least tested ones) are 3.6 up to 3.9.

pip (PyPI)

Since probeye is frequently updated on the Python package index (PyPI), you can install the most recent stable version simply by running pip from the command line:

pip install probeye

Please note that there are several dependencies which might take some time to download and install, if they are not installed in your environment yet.

pip (GitHub)

If you want to install the package directly from the latest version on GitHub (for example when this version is not published on PyPI yet), just clone the repository and install the package locally by running from the root of the repository the following command:

User

pip install .

Developer (Windows)

pip install -e .[tests,lint_type_checks,docs]

Developer (Linux)

pip install --user ".[tests,lint_type_checks,docs]"

Please note that there are several dependencies which might take some time to download and install, if they are not installed in your environment yet.