restyle and rename write_charts.py to charts.py

library/charts.py

@@ -0,0 +1,372 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2024, Marco Noce <[email protected]>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+---
+module: charts
+author:
+    - Marco Noce (@NomakCooper)
+description:
+  - This module generates various types of charts (line, bar, pie, donut) and saves them as images.
+  - It provides customization options for titles, colors, sizes, fonts, and legend placements.
+  - Supports modern aesthetics with soft gridlines, contrasting backgrounds, and well-structured layout design.
+  - Ensures high readability and presentation-ready output.
+  - Uses Plotly for visualization.
+requirements:
+  - Kaleido
+  - Plotly
+short_description: Generate high-quality charts using Plotly and save them as images.
+options:
+  titlechart:
+    description: Title of the chart.
+    required: false
+    type: str
+  type:
+    description: Type of chart to generate.
+    required: true
+    type: str
+    choices: [line, bar, pie, donut]
+  xaxis:
+    description: X-axis data values.
+    required: false
+    type: list
+    elements: str
+  xaxisname:
+    description: Label for the X-axis.
+    required: false
+    type: str
+  yaxis:
+    description: List of Y-axis data series.
+    required: false
+    type: list
+    elements: list
+  yaxisname:
+    description: Labels for the Y-axis data series.
+    required: false
+    type: list
+    elements: str
+  yaxiscolor:
+    description: Colors for the Y-axis data series.
+    required: false
+    type: list
+    elements: str
+  imgwidth:
+    description: Width of the generated chart image (in pixels).
+    required: false
+    type: int
+    default: 1920
+  imgheight:
+    description: Height of the generated chart image (in pixels).
+    required: false
+    type: int
+    default: 1080
+  shape_line:
+    description: Line shape for line charts.
+    required: false
+    type: str
+    choices: [spline, linear]
+  format:
+    description: Image format for saving the chart.
+    required: false
+    type: str
+    choices: [png, jpeg, webp, svg, pdf, eps]
+    default: png
+  path:
+    description: Path where the chart image will be saved.
+    required: true
+    type: str
+  filename:
+    description: Filename for the saved chart.
+    required: true
+    type: str
+  fontsize:
+    description: Font size for labels and text.
+    required: false
+    type: int
+    default: 20
+  fontcolor:
+    description: Font color for chart text.
+    required: false
+    type: str
+    default: '#333333'
+  titlelegend:
+    description: Title for the legend.
+    required: false
+    type: str
+  slicedata:
+    description: Data values for pie or donut chart slices.
+    required: false
+    type: list
+    elements: float
+  slicelabel:
+    description: Labels for pie or donut chart slices.
+    required: false
+    type: list
+    elements: str
+  slicecolor:
+    description: Colors for pie or donut chart slices.
+    required: false
+    type: list
+    elements: str
+  sizehole:
+    description: Size of the hole in a donut chart (0 for a full pie chart).
+    required: false
+    type: float
+    default: 0.5
+'''
+
+EXAMPLES = r'''
+- name: set line axis data
+  set_fact:
+    xdata: ['00:00','02:00','04:00','06:00','08:00','10:00','12:00','14:00','16:00','18:00','20:00','22:00']
+    y1data: [20,20,30,40,50,80,70,60,40,30,20,10]
+    y2data: [05,15,25,20,45,50,40,35,30,20,15,05]
+
+- name: Generate line chart
+  charts:
+    type: "line"
+    titlechart: "CPU Usage Over Time"
+    xaxis: "{{ xdata }}"
+    xaxisname: "Timestamp"
+    yaxis: [
+      "{{ y1data }}",
+      "{{ y2data }}"
+    ]
+    yaxisname: ["User %", "System %"]
+    yaxiscolor: ["red", "blue"]
+    shape_line: "spline"
+    imgwidth: 1920
+    imgheight: 1080
+    path: "/charts"
+    filename: "cpu_usage"
+    format: "png"
+    titlelegend: "CPU Breakdown"
+  delegate_to: localhost
+
+- name: Generate bar chart
+  charts:
+    type: "line"
+    titlechart: "CPU Usage Over Time"
+    xaxis: "{{ xdata }}"
+    xaxisname: "Timestamp"
+    yaxis: [
+      "{{ y1data }}",
+      "{{ y2data }}"
+    ]
+    yaxisname: ["User %", "System %"]
+    yaxiscolor: ["red", "blue"]
+    shape_line: "spline"
+    imgwidth: 1920
+    imgheight: 1080
+    path: "/charts"
+    filename: "cpu_usage"
+    format: "png"
+    titlelegend: "CPU Breakdown"
+  delegate_to: localhost
+
+- name: set pie fact
+  set_fact:
+    pielabel: ['sys','dba','webservice','application']
+    piedata: [10, 50, 20, 20]
+    piecolor: ["#1500ff", "#ff000d", "#eaff00", "#8700e8"]
+
+- name: Generate pie chart
+  charts:
+    type: "pie"
+    titlechart: "Swap Usage Breakdown"
+    slicelabel: "{{ pielabel }}"
+    slicedata: "{{ piedata }}"
+    slicecolor: "{{ piecolor }}"
+    imgwidth: 800
+    imgheight: 600
+    path: "/charts"
+    filename: "app_pie"
+    format: "png"
+  delegate_to: localhost
+
+- name: Generate pie chart
+  charts:
+    type: "donut"
+    titlechart: "Swap Usage Breakdown"
+    slicelabel: "{{ pielabel }}"
+    slicedata: "{{ piedata }}"
+    slicecolor: "{{ piecolor }}"
+    imgwidth: 800
+    imgheight: 600
+    path: "/charts"
+    filename: "app_pie"
+    format: "png"
+  delegate_to: localhost
+
+'''
+
+RETURN = r'''
+changed:
+    description: The change status.
+    type: bool
+    returned: if image files have been generated
+    sample: true
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+import plotly.graph_objects as go
+import os
+
+def save_figure(fig, module):
+    """ Save figure to the specified path with given format """
+    filepath = module.params['path']
+    imgname = module.params['filename']
+    fileformat = module.params['format']
+
+    os.makedirs(filepath, exist_ok=True)
+
+    fig.write_image(f"{filepath}/{imgname}.{fileformat}")
+
+def create_line_or_bar_chart(module, chart_type):
+    """ Create a Line or Bar chart with a professional light theme """
+    fig = go.Figure()
+    xdata = module.params['xaxis']
+    ydata = module.params['yaxis']
+    ynames = module.params['yaxisname']
+    ycolors = module.params['yaxiscolor']
+
+    shape = module.params.get('shape_line', 'spline') if chart_type == "line" else None
+
+    for y, name, color in zip(ydata, ynames, ycolors):
+        if chart_type == "line":
+            fig.add_trace(go.Scatter(
+                x=xdata, y=y, name=name,
+                line=dict(color=color, shape=shape, width=3),
+                mode='lines+markers',
+                marker=dict(size=8, symbol='circle', line=dict(width=1, color="black"))
+            ))
+        elif chart_type == "bar":
+            fig.add_trace(go.Bar(
+                x=xdata, y=y, name=name,
+                marker=dict(
+                    color=color,
+                    line=dict(width=1, color="black"),
+                    opacity=0.9
+                )
+            ))
+
+    update_layout(fig, module, is_bar=(chart_type == "bar"))
+    return fig
+
+def create_pie_or_donut_chart(module, chart_type):
+    """ Create a Pie or Donut chart with a professional light theme """
+    fig = go.Figure()
+
+    fig.add_trace(go.Pie(
+        labels=module.params['slicelabel'],
+        values=module.params['slicedata'],
+        marker=dict(colors=module.params['slicecolor'],
+                    line=dict(color="black", width=2)),
+        hole=module.params['sizehole'] if chart_type == "donut" else 0,
+        pull=[0.05 if i % 2 == 0 else 0 for i in range(len(module.params['slicelabel']))],
+        textinfo='label+percent',
+        insidetextorientation='radial'
+    ))
+
+    update_layout(fig, module, is_pie=True)
+    return fig
+
+def update_layout(fig, module, is_bar=False, is_pie=False):
+    """ Update layout with a modern, professional aesthetic """
+    fig.update_layout(
+        autosize=False,
+        width=module.params['imgwidth'],
+        height=module.params['imgheight'],
+        title=dict(
+            text=module.params['titlechart'],
+            font=dict(size=28, color='#333333', family="Roboto, Montserrat, Arial Black"),
+            x=0.5
+        ),
+        xaxis=dict(
+            title=module.params.get('xaxisname'),
+            title_font=dict(size=18, family="Roboto, Montserrat"),
+            showgrid=True,
+            gridcolor="rgba(200,200,200,0.4)",
+            zeroline=False,
+            showline=True,
+            linecolor="rgba(100,100,100,0.5)"
+        ),
+        yaxis=dict(
+            title=", ".join(module.params.get('yaxisname', [])),
+            title_font=dict(size=18, family="Roboto, Montserrat"),
+            showgrid=True,
+            gridcolor="rgba(200,200,200,0.4)",
+            zeroline=False,
+            showline=True,
+            linecolor="rgba(100,100,100,0.5)"
+        ) if not is_bar else None,
+        legend=dict(
+            title_text=module.params.get('titlelegend'),
+            font=dict(size=16, family="Roboto, Montserrat"),
+            bordercolor="rgba(50,50,50,0.3)",
+            borderwidth=1,
+            x=1.02,
+            y=0.5
+        ),
+        font=dict(
+            family="Roboto, Montserrat",
+            size=16,
+            color="black"
+        ),
+        plot_bgcolor="rgba(245, 245, 245, 1)",
+        paper_bgcolor="white"
+    )
+
+def run_module():
+    module_args = dict(
+        titlechart=dict(type='str'),
+        type=dict(type='str', required=True, choices=['line', 'bar', 'pie', 'donut']),
+        xaxis=dict(type='list', default=[]),
+        xaxisname=dict(type='str'),
+        yaxis=dict(type='list', default=[]),
+        yaxisname=dict(type='list', default=[]),
+        yaxiscolor=dict(type='list', default=[]),
+        imgwidth=dict(type='int', default=1920),
+        imgheight=dict(type='int', default=1080),
+        shape_line=dict(type='str', choices=['spline', 'linear']),
+        format=dict(type='str', default='png', choices=['png', 'jpeg', 'webp', 'svg', 'pdf', 'eps']),
+        path=dict(type='str', required=True),
+        filename=dict(type='str', required=True),
+        fontsize=dict(type='int', default=20),
+        fontcolor=dict(type='str', default='#333333'),
+        titlelegend=dict(type='str'),
+        slicedata=dict(type='list', default=[]),
+        slicelabel=dict(type='list', default=[]),
+        slicecolor=dict(type='list', default=[]),
+        sizehole=dict(type='float', default=0.5),
+    )
+
+    module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
+    result = dict(changed=False)
+
+    chart_type = module.params['type']
+    fig = None
+
+    if chart_type in ["line", "bar"]:
+        fig = create_line_or_bar_chart(module, chart_type)
+    elif chart_type in ["pie", "donut"]:
+        fig = create_pie_or_donut_chart(module, chart_type)
+
+    if fig:
+        save_figure(fig, module)
+        result['changed'] = True
+
+    module.exit_json(**result)
+
+def main():
+    run_module()
+
+if __name__ == '__main__':
+    main()