ModuleTester 1.0.1

ℹ️ Created by Codra in 2023, developed and maintained by ModuleTester open-source project team with the support of Codra.

ℹ️ ModuleTester is powered by PlotPyStack 🚀.

Overview

ModuleTester is a GUI and CLI test management tool for Python packages. It automatically discovers test scripts, runs them, and generates detailed reports in multiple formats.

Key features:

• Dockable panel layout — fully customizable workspace with resizable, floatable panels
• Tree view navigation — hierarchical test browser with status icons, notifications, and live spinner during execution
• Multi-format export — generate reports in HTML, DOCX, ODT, PDF, Markdown, and reStructuredText via a Jinja2-based engine
• CLI support — run tests and export reports without the GUI (moduletester-cli run, moduletester-cli export)
• Built-in configuration editor — edit settings directly in the GUI with error handling and conflict resolution
• Notification system — visual indicators on tabs and tree items for new output and errors

ModuleTester is a spin-off of DataLab and is used to test PlotPyStack libraries.

Quick Start

1. Install ModuleTester:

   pip install ModuleTester
   

2. Mark test scripts you want to see in the GUI by adding a comment at the top of each script:

   # guitest: show
   

3. Launch the GUI on your package:

   moduletester --module mypackage
   

   Or use the CLI to run tests headlessly:

   moduletester-cli run mypackage
   

4. Export a report:

   moduletester-cli export mypackage --output report.html
   

Example

ModuleTester ships with a complete Example Calculator project in the example/ directory that demonstrates all three test categories: manual GUI tests, unit tests with coverage, and qualification scripts.

See the integration guide for a step-by-step tutorial on adding ModuleTester to your own project.

Documentation

Full documentation is available at moduletester.readthedocs.io.

• Installation guide
• Usage (GUI & CLI)
• Changelog

Credits

Copyrights and licensing:

• Copyright © 2023 Codra.
• Licensed under the terms of the BSD 3-Clause (see LICENSE).

Dependencies and other installation methods

See Installation section in the documentation for more details.