Installation

Dependencies

The ModuleTester package requires the following Python modules:

Name	Version	Summary
Python	>=3.9, <4	Python programming language
guidata	>= 3.14	Automatic GUI generation for easy dataset editing and display
QtPy	>= 1.9	Provides an abstraction layer on top of the various Qt bindings (PyQt5/6 and PySide2/6).
pyqtwebengine		Python bindings for the Qt WebEngine framework
pypandoc		Thin wrapper for pandoc.
jinja2		A very fast and expressive template engine.
beautifulsoup4		Screen-scraping library

Optional modules for development:

Name	Version	Summary
ruff		An extremely fast Python linter and code formatter, written in Rust.
pylint		python code static checker
pytest		pytest: simple powerful testing with Python
Coverage		Code coverage measurement for Python
build		A simple, correct Python build frontend

Optional modules for building the documentation:

Name	Version	Summary
PyQt5		Python bindings for the Qt cross platform application toolkit
sphinx	>6	Python documentation generator
pydata_sphinx_theme		Bootstrap-based Sphinx theme from the PyData community

Note

Python 3.9+ is required. PyQt5 or PySide2 can be used as Qt binding (through QtPy).

How to install

From PyPI:

The easiest way to install ModuleTester is from PyPI:

$ pip install ModuleTester

From a wheel package:

On any operating system, using pip and the Wheel package:

$ pip install --upgrade moduletester-1.0.0-py3-none-any.whl

Pandoc (optional):

ModuleTester uses Pandoc and PyPandoc bindings to generate documents and display test descriptions. You can get Pandoc from here or by executing the following python code (all instructions are available on the PyPandoc documentation).

import pypandoc
from pypandoc.pandoc_download import download_pandoc
# see the documentation how to customize the installation path
# but be aware that you then need to include it in the `PATH`
download_pandoc()
# check the install path with
print(pypandoc.get_pandoc_path())

From source:

Installing ModuleTester directly from the source package is straightforward:

$ pip install .

Or to build a distribution package:

$ python -m build