basic-report 0.2.2__tar.gz → 0.3.0__tar.gz

{basic_report-0.2.2 → basic_report-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-report
-Version: 0.2.2
+Version: 0.3.0
 Summary: A lightweight Python package for generating clean, professional static HTML reports.
 Keywords: html,report,static,responsive,website
 Author: Björn Scholz

{basic_report-0.2.2 → basic_report-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "basic-report"
-version = "0.2.2"
+version = "0.3.0"
 description = "A lightweight Python package for generating clean, professional static HTML reports."
 readme = "README.md"
 requires-python = ">=3.11"

basic_report-0.3.0/src/basic_report/configs/default.yaml

@@ -0,0 +1,500 @@
+timezone: 'Europe/Berlin'
+
+css:
+  site:
+    dark:
+      site_face_color: '#fefefa'
+      site_background_color: '#1f1f1f'
+    light:
+      site_face_color: '#1f1f1f'
+      site_background_color: '#fefefa'
+
+  tabs:
+    dark:
+      tab_border_bottom_color: '#414951'
+      tab_border_bottom_size: '2px'
+      tab_inactive_font_color: '#7a848c'
+      tab_inactive_font_weight: 'lighter'
+      tab_hover_font_color: '#dae2ef'
+      tab_active_font_color: '#dae2ef'
+      tab_active_font_weight: 'bolder'
+      tab_active_background_color: 'none'
+      tab_active_border_bottom_color: '#dae2ef'
+      tab_active_border_bottom_size: '2px'
+    light:
+      tab_border_bottom_color: '#abb1bc'
+      tab_border_bottom_size: '2px'
+      tab_inactive_font_color: '#abb1bc'
+      tab_inactive_font_weight: 'lighter'
+      tab_hover_font_color: '#414951'
+      tab_active_font_color: '#414951'
+      tab_active_font_weight: 'bolder'
+      tab_active_background_color: 'none'
+      tab_active_border_bottom_color: '#414951'
+      tab_active_border_bottom_size: '2px'
+
+  accordion:
+    dark:
+      accordion_border_color: '#414951'
+      accordion_border_size: '1px'
+      accordion_link_color: '#dae2ef'
+      accordion_header_background_color: '#2a2d2e'
+      accordion_body_top_border_color: '#dae2ef'
+      accordion_body_top_border_size: '1px'
+      accordion_body_background_color: '#313131'
+      accordion_body_font_color: '#dae2ef'
+    light:
+      accordion_border_color: '#cbcbc7'
+      accordion_border_size: '1px'
+      accordion_link_color: '#91989d'
+      accordion_header_background_color: '#f1f1ed'
+      accordion_body_top_border_color: '#bebeba'
+      accordion_body_top_border_size: '1px'
+      accordion_body_background_color: '#fefffa'
+      accordion_body_font_color: '#828995'
+
+  table:
+    dark:
+      table_controls_background_color: '#2a2d2e'
+      table_controls_border_color: '#555'
+      table_controls_font_color: '#dae2ef'
+      table_pagination_border_color: '#313131'
+      table_pagination_hover_border_color: '#66b2ff'
+      table_pagination_hover_font_color: '#66b2ff'
+      table_pagination_active_background_color: '#66b2ff'
+      table_pagination_active_border_color: '#66b2ff'
+      table_pagination_active_font_color: '#000'
+    light:
+      table_controls_background_color: '#f1f1ed'
+      table_controls_border_color: '#dee2e6'
+      table_controls_font_color: '#414951'
+      table_pagination_border_color: '#313131'
+      table_pagination_hover_border_color: '#66b2ff'
+      table_pagination_hover_font_color: '#66b2ff'
+      table_pagination_active_background_color: '#66b2ff'
+      table_pagination_active_border_color: '#66b2ff'
+      table_pagination_active_font_color: '#000'
+
+default_color_profiles:
+  dark:
+    report_header: steel 
+    header: slate
+    sub-header: slate
+    table: slate
+    report_ball: slate
+    text: slate
+    navbar: slate
+    section_title: 
+      text: slate
+      bars: slate
+    card:
+      text: steel
+      background: dark-gray
+      border: steel
+      header_text: medium-gray
+      header_background: ultra-dark-gray
+      header_border: steel
+      footer_text: medium-gray
+      footer_background: ultra-dark-gray
+      footer_border: steel
+
+  light:
+    report_header: steel
+    header: slate
+    sub-header: slate
+    table: slate
+    report_ball: slate
+    text: slate
+    navbar: slate
+    section_title: 
+      text: slate
+      bars: slate
+    card:
+      text: slate
+      background: white
+      border: slate
+      header_text: slate
+      header_background: ultra-light-gray
+      header_border: slate
+      footer_text: slate
+      footer_background: ultra-light-gray
+      footer_border: slate
+
+custom_colors:
+  black:
+    border_dark: '#000'
+    border_light: '#000'
+    font_and_background: '#000'
+    face_color: '#fff0f3'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  white:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#fff'
+    face_color: '#52595d'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  ultra-light-gray:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#d3d3d3'
+    face_color: '#52595d'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  light-gray:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#a9a9a9'
+    face_color: '#52595d'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  medium-gray:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#686a6c'
+    face_color: '#fff0f3'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  dark-gray:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#3a3b3c'
+    face_color: '#fff0f3'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  ultra-dark-gray:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#1c1c1c'
+    face_color: '#fff0f3'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  steel:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#495057'
+    face_color: '#fff0f3'
+    link: '#ced4da'
+    hover: '#212529'
+
+  slate:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#708090'
+    face_color: '#fff0f3'
+    link: '#abc4dc'
+    hover: '#374550'
+
+  broccoli:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#026c3d'
+    face_color: '#fff0f3'
+    link: '#a1c5a1'
+    hover: '#001f11'
+
+  forest:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#5d805d'
+    face_color: '#fff0f3'
+    link: '#c2c5aa'
+    hover: '#253325'
+
+  basil:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#829f82'
+    face_color: '#fff0f3'
+    link: '#516351'
+    hover: '#191f19'
+
+  alpine:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#1b5448'
+    face_color: '#fff0f3'
+    link: '#8cc8c8'
+    hover: '#14364a'
+
+  teal:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#045d5d'
+    face_color: '#fff0f3'
+    link: '#a9d6e5'
+    hover: '#14364a'
+
+  lagoon:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#8cc8c8'
+    face_color: '#fff0f3'
+    link: '#045d5d'
+    hover: '#0a201c'
+
+  navy:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#003366'
+    face_color: '#fff0f3'
+    link: '#a9d6e5'
+    hover: '#14364a'
+
+  ocean:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#2a6f97'
+    face_color: '#fff0f3'
+    link: '#a9d6e5'
+    hover: '#14364a'
+
+  sky:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#87afc7'
+    face_color: '#fff0f3'
+    link: '#4c6270'
+    hover: '#14364a'
+
+  burgundy:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#800020'
+    face_color: '#fff0f3'
+    link: '#ff8fa3'
+    hover: '#ac605e'
+
+  cherry:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#c9184a'
+    face_color: '#fff0f3'
+    link: '#ff8fa3'
+    hover: '#800f2f'
+
+  peach:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f98b88'
+    face_color: '#fff0f3'
+    link: '#800020'
+    hover: '#c9184a'
+
+  cocoa:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#35281e'
+    face_color: '#fff0f3'
+    link: '#e6b8a2'
+    hover: '#50362a'
+
+  earth:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#9d6b53'
+    face_color: '#fff0f3'
+    link: '#e6b8a2'
+    hover: '#50362a'
+
+  cappuccino:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#c09881'
+    face_color: '#fff0f3'
+    link: '#ffc394'
+    hover: '#1e1611'
+
+  papaya:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#ff5f1f'
+    face_color: '#fff0f3'
+    link: '#ffc16a'
+    hover: '#582820'
+
+  sunset:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f25c54'
+    face_color: '#fff0f3'
+    link: '#ffc16a'
+    hover: '#582820'
+
+  coral:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f9966b'
+    face_color: '#fff0f3'
+    link: '#ffd9c2'
+    hover: '#582820'
+
+  saffron:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#fbb917'
+    face_color: '#fff'
+    link: '#ffe2bd'
+    hover: '#eb6758'
+
+  sunrise:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f3b360'
+    face_color: '#fff'
+    link: '#ffe2bd'
+    hover: '#eb6758'
+
+  vanilla:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f3e5ab'
+    face_color: '#52595d'
+    link: '#9d6b53'
+    hover: '#eb6758'
+
+  ice:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f0f8ff'
+    face_color: '#4a7b9d'
+    link: '#449adc'
+    hover: '#b7dbff'
+
+  parchment:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#fefbe3'
+    face_color: '#8b6a4d'
+    link: '#cca67a'
+    hover: '#e1cdad'
+
+  mpg-green:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#006c66'
+    face_color: '#fff0f3'
+    link: '#00b8ae'
+    hover: '#00201e'
+
+  mpg-secondary-green:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#005555'
+    face_color: '#fff0f3'
+    link: '#00a1a1'
+    hover: '#00201e'
+
+  mpg-blue:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#29485d'
+    face_color: '#fff0f3'
+    link: '#5aa0cf'
+    hover: '#000d13'
+
+  mpg-secondary-blue:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#006699'
+    face_color: '#fff0f3'
+    link: '#57b0ff'
+    hover: '#000d13'
+
+  mpg-lime:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#cadb2a'
+    face_color: '#52595d'
+    link: '#6a7416'
+    hover: '#000d13'
+
+  mpg-secondary-lime:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#d9e371'
+    face_color: '#52595d'
+    link: '#5e6330'
+    hover: '#000d13'
+
+  mpg-orange:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f58220'
+    face_color: '#fff0f3'
+    link: '#ffd15e'
+    hover: '#000d13'
+
+  mpg-secondary-orange:
+    border_dark: '#000'
+    border_light: '#1e1e1e'
+    font_and_background: '#f8a35c'
+    face_color: '#fff0f3'
+    link: '#774e2c'
+    hover: '#000d13'
+
+heatmap:
+  misc:
+    range: 5
+    animation_duration: 200
+    vertical_orientation: False
+    tooltip_enabled: True
+    tooltip_function: 'predefined:date+value'
+    tooltip_precision: 2
+    legend_width: 300
+    legend_label: 'Test Legend'
+    legend_font_size: 14
+    legend_font_weight: 450
+
+  domain:
+    type: 'month' # hour, day, week, month, year
+    gutter: 4
+    padding: [0,0,0,0]
+    dynamic_dimensions: False
+    sort: 'asc'
+
+  label:
+    text: 'MMM' # YY, YYYY, M, MM, MMM, MMMM, D, DD, d, dd, ddd, dddd, H, HH, h, hh, null
+    position: 'bottom' # top, right, bottom, left
+    align: 'middle' # start, middle, end
+    offset: [0, 0]
+    rotate: null
+    width: 100
+    height: 100
+    font_size: 16
+    font_weight: 450
+
+  subdomain:
+    type: 'day' # minute, hour, day, week, month, xDay, ghDay
+    gutter: 2
+    width: 30
+    height: 30
+    radius: 0
+    sort: 'asc' # asc, desc
+    label: 'D' #M, MM, MMM, MMMM, D, DD, d, dd, ddd, dddd, H, HH, h, hh, m, mm, null
+    font_size: 14
+    font_weight: 450
+    background_color: '#ededed'
+
+  date:
+    start: '2026-03-01'
+    min: null
+    max: null
+    highlight: ['today']
+    weekstart: 1
+    timezone: 'Europe/Berlin'
+
+  color:
+    domain: [0, 10]   # Plot range, for linear interpolation use min max. For thresholds use more
+    scheme: 'YlOrRd'  # https://d3js.org/d3-scale-chromatic, set to null if range is used
+    range: null       # Hex codes to use as colormap, set to null if scheme is used
+    interpolate: null # rgb, hsl, lab, hcl, null
+    type: 'linear'    # https://cal-heatmap.com/docs/options/scale#type

basic_report-0.3.0/src/basic_report/css_and_scripts/basic_report/section_title.css

@@ -0,0 +1,41 @@
+.section-title {
+  display: flex;
+  align-items: center;
+  gap: 10px;
+  margin: 0 1em 10px 1em;
+  font-weight: 500;
+  letter-spacing: 2px;
+}
+
+.section-title::before,
+.section-title::after {
+  content: "";
+  height: 2px;
+  background: #616161;
+  flex: 0 1 80px;
+  min-width: 0;
+}
+
+.section-title.center {
+  justify-content: center;
+}
+
+.section-title.left {
+  justify-content: flex-start;
+}
+
+.section-title.left::before {
+  display: none;
+}
+
+.section-title.left::after {
+  flex: 0 1 80px;
+}
+
+.section-title.right {
+  justify-content: flex-end;
+}
+
+.section-title.right::after {
+  display: none;
+}

{basic_report-0.2.2 → basic_report-0.3.0}/src/basic_report/page.py

@@ -2,6 +2,7 @@ import datetime
 import numpy as np
 import pandas as pd
 import shutil
+import json
 
 from collections import defaultdict, ChainMap
 from jinja2 import Environment, FileSystemLoader
@@ -225,6 +226,41 @@ class ReportPage:
         self._update_content(html)
         self.close_sublevel()
 
+    # region Section Title
+    # --------------------
+    def add_section_title(
+            self,
+            title_text: str,
+            text_color: Optional[str]=None,
+            bar_color: Optional[str]=None,
+            alignment: Optional[Literal['left', 'center', 'right']]=None,
+        ):
+        """ Add a section title to the page
+
+        Args:
+            title_text (str): Title text
+            text_color (Optional[str]): Color of the title text
+            bar_color (Optional[str]): Color of the bars
+            alignment (Optional[str]): Alignment of the title. If left or right is chosen the bar will be omitted on the
+                chosen side
+        """
+        valid_alignments = {'left', 'center', 'right', None}
+        if alignment not in valid_alignments :
+            msg = f'Unknown alignment `{alignment}`. Use one of {valid_alignments}'
+            logger.error(msg)
+            raise RuntimeError(msg)
+        
+        alignment = default(alignment, 'center')
+        text_color = default(text_color, self.color_map.get_default_color('section_title.text'))
+        bar_color = default(bar_color, self.color_map.get_default_color('section_title.bars'))
+
+        template = self.jinja_env.get_template('elements/section_title.html')
+        html = template.render(title_text=title_text,
+                               text_color=text_color,
+                               bar_color=bar_color,
+                               alignment=alignment)
+        self._update_content(html)
+
     # region Table
     # ------------
     def add_table(
@@ -523,6 +559,103 @@ class ReportPage:
         tab_id = 'tabID_{}'.format(self.id_counter)
         self.page_buffers[-1].content_ids.append((name, tab_id))
 
+    # region Cards
+    # ------------
+    def open_cards(self, cards_type: Literal['group', 'deck', 'columns']):
+        """ Open a new cards environment
+        
+        Args:
+            cards_type (Literal['group', 'deck', 'columns']): Define the layout of how cards are grouped together
+        """
+        self.page_buffers.append(PageBuffer('cards'))
+        self.page_buffers[-1].info = cards_type
+
+    def close_cards(self):
+        """ Close current cards environment """
+        self._is_page_in_status('cards')
+
+        card_items = []
+        for card in self.page_buffers[-1].content_ids:
+            card_body = '\n'.join(self.page_buffers[-1].content_buffer[card])
+            card_cfg = json.loads(card[0])
+            item = ChainMap(card_cfg, {'card_body': card_body})
+            card_items.append(item)
+        template = self.jinja_env.get_template('elements/cards.html')
+        html = template.render(
+            cards_type=self.page_buffers[-1].info,
+            card_items=card_items,
+        )
+
+        self.page_buffers = self.page_buffers[:-1]
+        self._update_content(html)
+
+    def add_card(
+            self,
+            *,
+            background_color: str | None = None,
+            border_color: str | None = None,
+            image: str | None = None,
+            header_text: str | None = None,
+            header_text_color: str | None = None,
+            header_background_color: str | None = None,
+            header_border_color: str | None = None,
+            footer_text: str | None = None,
+            footer_text_color: str | None = None,
+            footer_background_color: str | None = None,
+            footer_border_color: str | None = None,
+            max_width: str='18rem'
+        ):
+        """ Add a section title to the page
+
+        Args:
+            background_color (str | None): The name of the background color for the whole card
+            border_color (str | None): The name of the border color for the whole card
+            image (str | None): A header image for the card. The source image will not be deleted!
+            header_text (str | None): Text to be shown as header of the card
+            header_text_color (str | None): The name of the header text color
+            header_background_color (str | None): The name of the background color for the header section
+            header_border_color (str | None): The name of the border color for the header section, only really
+            footer_text (str | None): Text to be shown as footer of the card
+            footer_text_color (str | None): The name of the footer text color
+            footer_background_color (str | None): The name of the background color for the footer section
+            footer_border_color (str | None): The name of the border color for the footer section, only really
+                affects the line between the footer and the body
+            max_width (str): The maximum width of the card
+        """
+        self._is_page_in_status('cards')
+
+        self.img_dir.mkdir(parents=True, exist_ok=True)
+
+        if image is not None:
+            image_source = Path(image)
+            image_name = image_source.name
+            image_dest = self.img_dir / image_name
+            shutil.copyfile(image_source, image_dest)
+            image = (self.rel_dir / 'images' / image_name).as_posix()
+
+        card_cfg = {
+            'image_source': image,
+            'max_width': max_width,
+
+            'background_color': default(background_color, self.color_map.get_default_color('card.background')),
+            'border_color': default(border_color, self.color_map.get_default_color('card.border')),
+
+            'header_text': header_text,
+            'header_text_color':  default(header_text_color, self.color_map.get_default_color('card.header_text')),
+            'header_background_color':  default(header_background_color, self.color_map.get_default_color('card.header_background')),
+            'header_border_color':  default(header_border_color, self.color_map.get_default_color('card.header_border')),
+
+            'footer_text': footer_text,
+            'footer_text_color': default(footer_text_color, self.color_map.get_default_color('card.footer_text')),
+            'footer_background_color': default(footer_background_color, self.color_map.get_default_color('card.footer_background')),
+            'footer_border_color': default(footer_border_color, self.color_map.get_default_color('card.footer_border')),
+        }
+        card_cfg = json.dumps(card_cfg)
+
+        self.id_counter += 1
+        card_id = 'cardID_{}'.format(self.id_counter)
+        self.page_buffers[-1].content_ids.append((card_cfg, card_id))
+
     # region Navbar
     # -------------
     def open_navbar(