diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 368cc70..ca80f49 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,8 +2,8 @@ name: Build & Check Package on: push: - # branches: - # - main + branches: + - main paths: - '**.py' - pyproject.toml diff --git a/README.md b/README.md index e2bf975..436ca11 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,35 @@ Keywords from this repository can visualize CSV data as graph within the robotfr [![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) + +## 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 + +```python +*** Settings *** +Library Visualizer + + +*** Test Cases *** +Visualize Data + ${csv_file_path} = Keyword.Write Data To Csv + Visualizer.Add To Diagram ${csv_file_path} _time _value Value Axis Blue + Visualizer.Visualize +``` diff --git a/pyproject.toml b/pyproject.toml index ac4b7d1..fdb4bcd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ name = "robotframework-visualizer" dynamic = ["version"] description = "A Robot Framework library providing keywords for the visualization of 'date / value' objects." readme = "README.md" -requires-python = ">=3.8" +requires-python = ">=3.10" authors = [ { name = "Marvin Klerx", email = "marvinklerx20@gmail.com" } ]