Metadata-Version: 2.4
Name: robotframework-visualizer
Version: 0.0.8
Summary: A Robot Framework library providing keywords for the visualization of 'date / value' objects.
Project-URL: Repository, https://github.com/MarvKler/robotframework-visualizer
Project-URL: Documentation, https://github.com/MarvKler/robotframework-visualizer#readme
Project-URL: Issues, https://github.com/MarvKler/robotframework-visualizer/issues
Author-email: Marvin Klerx <marvinklerx20@gmail.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: matplotlib
Requires-Dist: overrides
Requires-Dist: pandas
Requires-Dist: robotframework
Requires-Dist: robotframework-pythonlibcore
Provides-Extra: dev
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# Robot Framework Visualizer
Keywords from this repository can visualize CSV data as graph within the robotframework log file.

## Statistics

[![Release Pipeline](https://github.com/MarvKler/robotframework-visualizer/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-visualizer/actions/workflows/release.yml)  
[![PyPI - Version](https://img.shields.io/pypi/v/robotframework-visualizer.svg)](https://pypi.org/project/robotframework-visualizer)    
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-visualizer.svg)](https://pypi.org/project/robotframework-visualizer)   
[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-visualizer)](https://pepy.tech/projects/robotframework-visualizer)    
[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-visualizer/month)](https://pepy.tech/projects/robotframework-visualizer)  

## GitHub Repository

Link to GitHub Project: [robotframework-visualizer](https://github.com/MarvKler/robotframework-visualizer)

## Keyword Documentation

Find here the keyword documentation: [Keyword Documentation](https://marvkler.github.io/robotframework-visualizer/keywords.html)

## Use Case

If you have time-series data like energey measurements or temperature values over period of time, you can use this library to visualize thos raw data as visual diagram into your robot framework logfile.     
The generated diagram is saved as ``png`` file in your output directory and visualized as html image in your log file.

> [!IMPORTANT]
> X-Axis data should contain always the date-time value. The real value should be placed on Y-Axis.

## Installation

```shell
pip install robotframework-visualizer
```

## Usage

```robot
*** Settings ***
Library    Visualizer


*** Test Cases ***
Add One Data Set
    [Documentation]    Add one graph to diagram.
    Visualizer.Add To Diagramm    ${CURDIR}${/}testdata${/}dummy_strom_spannung.csv    _time    _strom    Strom    Blue
    Visualizer.Visualize    Strom / Spannung Verlauf

Add Two Data Sets
    [Documentation]    Add two graphs to diagram.
    Visualizer.Add To Diagramm    ${CURDIR}${/}testdata${/}dummy_strom_spannung.csv    _time    _spannung    Spannung    Green
    Visualizer.Add To Diagramm    ${CURDIR}${/}testdata${/}dummy_strom_spannung.csv    _time    _strom    Strom    Blue
    Visualizer.Visualize    Strom / Spannung Verlauf
```

## Result

### Added one graph to diagram
![alt text](docs/one_graph.png)

### Added one graph to diagram
![alt text](docs/two_graphs.png)