HtmlTestRunner

screenshot of HtmlTestRunner

A Test Runner in python, for Human Readable HTML Reports

Overview

HtmlTestRunner is a powerful unittest test runner designed to enhance your testing workflow by presenting results in a clear and visually appealing HTML format. This tool, inspired by previous HTML runners and XML reporting systems, aims to combine the best features of both, delivering a straightforward yet effective solution for developers looking to create comprehensive test reports. Whether you're working on personal projects or collaborating in a larger team setting, HtmlTestRunner streamlines the reporting process, making it easier to analyze testing outcomes.

With its easy installation and versatile usage options, HtmlTestRunner is a valuable asset for any developer utilizing Python's unittest framework. Its features cater to a variety of testing needs, allowing users to generate customized reports and integrate their own templates, ensuring that the presentation of results aligns with project requirements.

Features

  • Easy Installation: Install HtmlTestRunner via pip to access the latest stable version effortlessly, simplifying the setup process for users.

  • Customizable Reporting: Specify custom report filenames and dictate how reports are combined, allowing for better organization and clarity based on your project needs.

  • Human-readable Output: Reports are generated in HTML format, making them not only easy to read but also visually appealing for team presentations or documentation.

  • Template Support: Import your own custom templates with jinja2 syntax, providing flexibility to create personalized reporting styles that fit your branding or preference.

  • Detailed Test Summaries: Each report contains comprehensive summaries, including the number of tests passed, failed, errored, or skipped, along with total duration, empowering better understanding of test performances.

  • Built-in Console Output: See expected console outputs during execution, offering instant feedback on test statuses as they run, helping developers quickly identify issues.

  • Multi-Test Suite Compatibility: Use HtmlTestRunner with both individual tests and test suites, ensuring it fits effortlessly into various testing setups.