basic-report 0.1.0__py3-none-any.whl

basic_report/templates/navbar_top.html

@@ -0,0 +1,25 @@
+<div class="container p-2">
+  <ul class="nav nav-pills" role="tablist">
+    {% for item in navbar_items -%}
+      <li class="nav-item p-1 pill-{{ color }}">
+      {% if loop.index == 1 %}
+      <a class="nav-link active" data-toggle="pill" href="#{{ item[1] }}" role="tab">{{ item[0] }}</a>
+      {% else %}
+        <a class="nav-link" data-toggle="pill" href="#{{ item[1] }}" role="tab">{{ item[0] }}</a>
+      {% endif %}
+      </li>
+    {%- endfor %}
+  </ul>
+</div>
+
+<div class="container p-2">
+  <div class="tab-content">
+    {% for item in navbar_items -%}
+      {% if loop.index == 1 %}
+        <div class="tab-pane fade show active" id="{{ item[1] }}">{{ item[2] }}</div>
+      {% else %}
+        <div class="tab-pane fade" id="{{ item[1] }}">{{ item[2] }}</div>
+      {% endif %}
+    {% endfor %}
+  </div>
+</div>

basic_report/templates/plot.html

@@ -0,0 +1,4 @@
+<div class='container p-2'>
+  {{ script | safe }}
+  {{ div | safe }}
+</div>

basic_report/templates/report_ball_section.html

@@ -0,0 +1,80 @@
+<p>
+  <div class="container">
+    <div class="row justify-content-center">
+      <div class="col-3">
+        {%- if errors|length > 0 %}
+          <button class="btn btn-danger btn-block" type="button" data-toggle="collapse" data-target="#report_ball_errors">
+            Errors <span class="badge badge-light"> {{ errors|length }} </span>
+          </button>
+        {%- else %}
+          <button class="btn btn-outline-dark btn-block disabled" type="button">
+            No Errors
+          </button>
+        {%- endif %}
+      </div>
+      <div class="col-3">
+        {%- if warnings|length > 0 %}
+          <button class="btn btn-warning btn-block" type="button" data-toggle="collapse" data-target="#report_ball_warnings">
+            Warnings <span class="badge badge-light"> {{ warnings|length }} </span>
+          </button>
+        {%- else %}
+          <button class="btn btn-outline-dark btn-block disabled" type="button">
+            No Warnings
+          </button>
+        {%- endif %}
+      </div>
+      <div class="col-3">
+        {%- if info|length > 0 %}
+          <button class="btn btn-success btn-block" type="button" data-toggle="collapse" data-target="#report_ball_info">
+            Info <span class="badge badge-light"> {{ info|length }} </span>
+          </button>
+        {%- else %}
+          <button class="btn btn-outline-dark btn-block disabled" type="button">
+            No Info
+          </button>
+        {%- endif %}
+      </div>
+    </div>
+  </div>
+</p>
+
+<p>
+<div class="container p-1">
+  {%- if errors|length > 0 %}
+  <div class="collapse" id="report_ball_errors">
+    <div class="alert alert-danger text-center" role="alert">Errors</div>
+    <div class="container">
+      <ol>
+      {% for item in errors -%}
+        <li class="text-{{ color }}">{{ item }}</li>
+      {%- endfor %}
+      </ol>
+    </div>
+  </div>
+  {%- endif -%}
+  {%- if warnings|length > 0 %}
+  <div class="collapse" id="report_ball_warnings">
+    <div class="alert alert-warning text-center" role="alert">Warnings</div>
+    <div class="container">
+      <ol>
+      {% for item in warnings -%}
+        <li class="text-{{ color }}">{{ item }}</li>
+      {%- endfor %}
+      </ol>
+    </div>
+  </div>  
+  {%- endif -%}
+  {%- if info|length > 0 %}
+  <div class="collapse" id="report_ball_info">
+    <div class="alert alert-success text-center" role="alert">Info</div>
+    <div class="container">
+      <ol>
+      {% for item in info -%}
+        <li class="text-{{ color }}">{{ item }}</li>
+      {%- endfor %}
+      </ol>
+    </div>
+  </div>  
+  {%- endif -%}
+</div>  
+</p>

basic_report/templates/report_header.html

@@ -0,0 +1,6 @@
+<div class="container p-1 justify-content-center">
+  <div class="alert alert-{{ header_color }} text-center shadow-sm p-3 mb-2" role="alert">
+    <h4>{{ report_name }}</h4>
+    {{ report_creation_time }}
+  </div>
+</div>

basic_report/templates/site.css

@@ -0,0 +1,5 @@
+html, body {
+  background-color: {{ site_background_color }};
+  color: {{ site_face_color }};
+  margin: 0;
+}

basic_report/templates/sublevel.html

@@ -0,0 +1,7 @@
+<div class="container p-1">
+    <div class="row align-items-{{ align }} justify-content-{{ align }}">
+    <div class="col-{{ size }}">
+      {{ content }}
+    </div>
+  </div>
+</div>

basic_report/templates/table.css

@@ -0,0 +1,51 @@
+
+/* Search input + length dropdown */
+.dataTables_wrapper .form-control {
+    background-color: {{ table_controls_background_color }};
+    border: 1px solid {{ table_controls_border_color }};
+    color: {{ table_controls_font_color }};
+}
+
+/* Focus state */
+.dataTables_wrapper .form-control:focus {
+    background-color: {{ table_controls_background_color }};
+    border-color: {{ table_controls_border_color }};
+    color: {{ table_controls_font_color }};
+    box-shadow: none;
+}
+
+.dataTables_wrapper {
+    color: {{ table_controls_font_color }};
+}
+
+.dataTables_wrapper .dataTables_info,
+.dataTables_wrapper .dataTables_length label,
+.dataTables_wrapper .dataTables_filter label {
+    color: {{ table_controls_font_color }};
+}
+
+/* Pagination container */
+.dataTables_wrapper .pagination .page-link {
+    background-color: {{ table_controls_background_color }};
+    border: 1px solid {{ table_controls_border_color }};
+    color: {{ table_controls_font_color }};
+}
+
+/* Hover */
+.dataTables_wrapper .pagination .page-link:hover {
+    background-color: {{ table_controls_background_color }};
+    border-color: {{ table_pagination_hover_border_color }};
+    color: {{ table_pagination_hover_font_color }};
+}
+
+/* Active page */
+.dataTables_wrapper .pagination .page-item.active .page-link {
+    background-color: {{ table_pagination_active_background_color }};
+    border-color: {{ table_pagination_active_border_color }};
+    color: {{ table_pagination_active_font_color }};
+}
+
+.dataTables_wrapper .pagination .page-link:focus {
+    outline: none;
+    box-shadow: none;
+}

basic_report/templates/table.html

@@ -0,0 +1,55 @@
+<script>
+var {{ table_id }}DataSet = {{ table_data }};
+
+$(document).ready(function() {
+  $('#{{ table_id }}').DataTable( {
+      data: {{ table_id }}DataSet,
+      columns: [
+        {% for c in table_columns -%}
+          { title: "{{ c }}" },
+        {% endfor %} ],
+      {% if not 'page' in options -%}
+      "paging": false,
+      {%- endif %}
+      {% if not 'info' in options -%}
+      "info": false,
+      {%- endif %}
+      {% if not 'search' in options -%}
+      "searching": false,
+      {%- endif %}
+      {% if order is not none -%}
+      "order": {{ order }},
+      {%- endif %}
+      {% if 'no_sort' in options -%}
+      "ordering": false,
+      {%- endif -%}
+      "autoWidth": false,
+    } );
+} );
+</script>
+
+{% if 'full_width' in options %}
+<div class="container-fluid p-2">
+{% else %}
+<div class="container p-2">
+{% endif %}
+  <table id="{{ table_id }}" class="table text-{{ align }} text-{{ color }} table-striped table-sm">
+  {% if footers|length %}
+    <tfoot class="double-top-border">
+    {% for foot in footers %}
+      <tr>
+      {% for item in foot %}
+        <td>{{ item }}</td>
+      {% endfor %}
+      </tr>
+    {% endfor %}
+    </tfoot>
+  {% endif %}
+  {% if caption != "" %}
+    <caption>
+      {{ caption }}
+    </caption>
+  {% endif %}
+  </table>
+</div>
+

basic_report/templates/tabs.css

@@ -0,0 +1,20 @@
+.nav-tabs {
+    border-bottom: {{ tab_border_bottom_size }} solid {{ tab_border_bottom_color }};
+}
+
+.nav-tabs .nav-link {
+    color: {{ tab_inactive_font_color }};
+    font-weight: {{ tab_inactive_font_weight }};
+    border: none;
+}
+
+.nav-tabs .nav-link:hover {
+    color: {{ tab_hover_font_color }};
+}
+
+.nav-tabs .nav-link.active {
+    color: {{ tab_active_font_color }};
+    background: {{ tab_active_background_color }};
+    font-weight: {{ tab_active_font_weight }};
+    border-bottom: {{ tab_active_border_bottom_size }} solid {{ tab_active_border_bottom_color }};
+}

basic_report/templates/tabs.html

@@ -0,0 +1,29 @@
+<div class="container p-2">
+    <ul class="nav nav-tabs">
+      {% for item in tabbed_items %}
+        <li class="nav-item">
+          {% if loop.index == 1 %}
+            <a class="nav-link active" data-toggle="tab" href="#{{ item[1] }}">
+          {% else %}
+            <a class="nav-link" data-toggle="tab" href="#{{ item[1] }}">
+          {% endif %}
+          {{ item[0] }}
+          </a>
+        </li>
+      {% endfor %}
+    </ul>
+</div>
+
+<div class="container p-1">
+  <div class="tab-content justify-content-center">
+    {% for item in tabbed_items %}
+      {% if loop.index == 1 %}
+        <div class="tab-pane container active " id="{{ item[1] }}">
+      {% else %}
+        <div class="tab-pane container fade " id="{{ item[1] }}">
+      {% endif %}
+      {{ item[2] }}
+      </div>
+    {% endfor %}
+  </div>
+</div>

basic_report/templates/text.html

@@ -0,0 +1,3 @@
+<div class="container">
+    <p class="text-{{ color }} text-{{ align }}"> {{ text }}</p>
+</div>

basic_report/utils.py

@@ -0,0 +1,246 @@
+import datetime
+from jinja2 import Environment, FileSystemLoader
+from loguru import logger
+from pathlib import Path
+from typing import Any, Union, Optional
+
+from . import TEMPLATE_DIR
+
+#----------------------------------------------------------------------------------------------------------------------#
+# region COLOR MAP
+#----------------------------------------------------------------------------------------------------------------------#
+class ColorMap:
+    """ Color map object for handling the color space of the report """
+    def __init__(self, config: dict[str, Any], color_mode: str, text_color: Optional[str]=None):
+        """ Initialize a new color map given a config dict
+
+        Args:
+            config (dict[str, Any]): The configuration for this report. Mainly responsible for defining new color
+                profiles that can later be used
+            color_mode (str): Select the current color mode of the report, i.e., `dark` or `light`
+            text_color (Optional[str]): Override for the text color of the report. For a more granular approach use the
+                config file
+        """
+        self.config = config
+        self.color_mode = color_mode
+        self.text_color = text_color
+
+        # Prepare the jinja templater
+        self.file_loader = FileSystemLoader(TEMPLATE_DIR)
+        self.jinja_env = Environment(loader=self.file_loader)
+
+        # Default color map - Maps the default bootstrap colors to their respective color names
+        self.cm = {
+            'blue': 'primary',
+            'gray': 'secondary',
+            'green': 'success',
+            'red': 'danger',
+            'yellow': 'warning',
+            'teal': 'info',
+            'black': 'dark',
+            'primary': 'primary',
+            'secondary': 'secondary',
+            'success': 'success',
+            'danger': 'danger',
+            'warning': 'warning',
+            'info': 'info',
+            'dark': 'dark',
+            'light': 'light',
+        }
+
+        # Create the custom color CSS that will be injected and make the profiles available in the color map
+        for cc in self.config['custom_colors']:
+            self.cm[cc] = cc
+
+    #---------------#
+    # Magic Methods #
+    #---------------#
+    def __getitem__(self, key: str) -> str:
+        """ Verify the color name and return the proper color mapping """
+        return self.verify_and_get_color(key)
+
+    #---------#
+    # Private #
+    #---------#
+    def _make_color_css_files(self, output_dir: Path):
+        """ Create the custom color css file """
+        # Create CSS string
+        color_items = [v | {'name': k} for k,v in self.config['custom_colors'].items()]
+
+        # Color CSS
+        template = self.jinja_env.get_template('colors.css')
+        css = template.render(color_items=color_items)
+
+        # Dump to scripts dir
+        custom_color_file = output_dir / 'custom_colors.css'
+        custom_color_file.write_text(css)
+
+         # Color CSS
+        template = self.jinja_env.get_template('navbar.css')
+        css = template.render(color_items=color_items)
+
+        # Dump to scripts dir
+        navbar_file = output_dir / 'navbar.css'
+        navbar_file.write_text(css)
+
+    def _make_css_file(self, element_type: str, output_dir: Path):
+        """ Create the custom css files for the element type """
+        # Create CSS string
+        colors = self.config['css'][element_type][self.color_mode]
+        template = self.jinja_env.get_template(f'{element_type}.css')
+        css = template.render(**colors)
+
+        # Dump to scripts dir
+        css_file = output_dir / f'{element_type}.css'
+        css_file.write_text(css)
+
+    #-----#
+    # API #
+    #-----#
+    def verify_and_get_color(self, color: str) -> str:
+        """ Check that the requested color is actually available
+
+        Args:
+            color (str): Color to check
+
+        Returns:
+            str - color name to use
+        """
+        if color not in self.cm:
+            msg = f'No color `{color}` found. Available: {self.cm.keys()}'
+            logger.error(msg)
+            raise RuntimeError(msg)
+
+        return self.cm[color]
+
+    def get_default_color(self, field: str) -> str:
+        """ Determine the correct default color for a given color mode and field
+
+        Args:
+            field (str): The type/field the color should be used for
+            color_mode (str): The color mode of the report, i.e., either `light` or `dark`
+
+        Returns:
+            str - The color to be used
+        """
+        if self.text_color is None or field not in ['text', 'table', 'report_ball']:
+            color = self.config['default_color_profiles'][self.color_mode].get(field)
+        else:
+            color = self.text_color
+
+        if color is None:
+            msg = f'No default color defined for `{field}` with color mode `{self.color_mode}`'
+            logger.error(msg)
+            raise RuntimeError(msg)
+        return color
+
+    def make_css_files(self, output_dir: Path):
+        """ Create the custom css files for the site
+
+        Args:
+            output_dir (Path): The reports css and script dir
+        """
+        self._make_color_css_files(output_dir)
+        for element_type in ['site', 'tabs', 'accordion', 'table']:
+            self._make_css_file(element_type, output_dir)
+
+#----------------------------------------------------------------------------------------------------------------------#
+# region MISC HELPER
+#----------------------------------------------------------------------------------------------------------------------#
+def coerce_to_date(date: Union[str, int, datetime.date, datetime.datetime]) -> datetime.date:
+    """ Coerce random data formats to a datetime.date object
+
+    Args:
+        date (Union[str, int, datetime.date, datetime.datetime]): The date to coerce
+
+    Returns:
+        datetime.date - The coerce date object
+    """
+    if isinstance(date, datetime.date):
+        return date
+    elif isinstance(date, datetime.datetime):
+        return date.date
+    elif isinstance(date, int):
+        date = str(int)
+
+    if not isinstance(date, str):
+        msg = f'Cannot coerce date {date}'
+        logger.error(msg)
+        raise RuntimeError(msg)
+
+    if len(date) == 6: # noqa: PLR2004
+        year  = int(date[:2])
+        if year < 50:  # noqa: PLR2004
+            year += 2000
+        else:
+            year += 1900
+        month = int(date[2:4])
+        day   = int(date[4:])
+
+    elif len(date) == 8: # noqa: PLR2004
+        if date.isdigit():
+            year  = int(date[:4])
+            month = int(date[4:6])
+            day   = int(date[6:])
+        else:
+            year  = int(date[:2])
+            if year < 50:  # noqa: PLR2004
+                year += 2000
+            else:
+                year += 1900
+            month = int(date[3:5])
+            day   = int(date[6:])
+
+    elif len(date) == 10: # noqa: PLR2004
+        year  = int(date[:4])
+        month = int(date[5:7])
+        day   = int(date[8:])
+    return datetime.date(year, month, day)
+
+def verify_alignment(align: str) -> str:
+    """ Check that the requested alignment is actually available
+
+    Args:
+        align (str): The alignment tag that needs to be verified
+
+    Returns:
+        str - The alignment if it is acceptable
+    """
+    alignments = ['left', 'center', 'right']
+    if align not in alignments:
+        msg = f'Unknown alignment {align}. Available: {alignments}'
+        logger.error(msg)
+        raise RuntimeError(msg)
+    return align
+
+def verify_color_mode(color_mode: str) -> str:
+    """ Check that the requested alignment is actually available
+
+    Args:
+        color_mode (str): The alignment tag that needs to be verified
+
+    Returns:
+        str - The alignment if it is acceptable
+    """
+    color_modes = ['light', 'dark']
+    if color_mode not in color_modes:
+        msg = f'Unknown color_mode {color_mode}. Available: {color_modes}'
+        logger.error(msg)
+        raise RuntimeError(msg)
+    return color_mode
+
+def default(var: Any, default: Any) -> Any:
+    """ Helper function to check kwargs and set them to a default
+
+    You could simply use var or default. But for future additions we will use a separat function here
+    Args:
+        var (Any): The input variable
+        default (Any): Default value for the variable
+
+    Returns
+        Any - Either the variable itself, or the default value if var is `None`
+    """
+    if var is None:
+        return default
+    else:
+        return var