Skip to main content

Getting Started

AskUI provides a comprehensive reporting system that allows you to track and document your automation steps. Reporters capture execution details, screenshots, and results to help you analyze and debug your automation workflows.

Available Reporters

AskUI offers several built-in reporters to suit different needs:
  • SimpleHtmlReporter - Generates HTML reports with screenshots and step details
  • AllureReporter - Integrates with Allure reporting framework
  • Custom Reporter - Create your own reporter by implementing the Reporter interface

SimpleHtmlReporter

The SimpleHtmlReporter generates HTML reports with screenshots and execution details.

Basic Usage

The reports are saved in the reports/ directory and include step-by-step execution details with screenshots.

Enable Multiple Reporters

You can combine multiple reporters:

Allure Reporter

You can use this reporter in combination with Allure Reporter. If you use it in combination with your test framework like behave, pytest or others, we assume you’ve already set up Allure with your test framework.

Implement Your Own Reporter

To write your own reporter, you need to implement AskUI’s Reporter interface. It offers methods you can override to adapt to your specific reporting framework:

Reporter Interface Methods

The Reporter interface provides the following methods:
  • add_message() - Called for each automation step to log the action, content, and optional screenshots
  • generate() - Called at the end of the session to finalize the report
Both methods are optional and can be overridden based on your reporting needs.