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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-report
-Version: 0.3.0
+Version: 0.4.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.3.0 → basic_report-0.4.0}/pyproject.toml

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

basic_report-0.4.0/src/basic_report/__init__.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+# Make the package dir available in the module
+PACKAGE_DIR  = Path(__file__).parent
+PACKAGE_NAME = PACKAGE_DIR.name
+CONFIG_DIR   = PACKAGE_DIR / 'configs'
+TEMPLATE_DIR = PACKAGE_DIR / 'templates'
+SCRIPTS_DIR  = PACKAGE_DIR / 'css_and_scripts'
+
+# ruff: disable[E402]
+from .report import Report as Report
+from .heatmap import (
+    CalendarDomain as CalendarDomain,
+    CalendarLabel as CalendarLabel,
+    CalendarSubDomain as CalendarSubDomain,
+    CalendarDate as CalendarDate,
+    CalendarData as CalendarData,
+    CalendarColor as CalendarColor,
+    CalendarMisc as CalendarMisc,
+    CalendarHeatmap as CalendarHeatmap,
+)
+# ruff: enable[E402]

{basic_report-0.3.0 → basic_report-0.4.0}/src/basic_report/configs/default.yaml

@@ -87,6 +87,9 @@ default_color_profiles:
     section_title: 
       text: slate
       bars: slate
+    dictionary:
+      key: light-gray
+      value: slate
     card:
       text: steel
       background: dark-gray
@@ -109,6 +112,9 @@ default_color_profiles:
     section_title: 
       text: slate
       bars: slate
+    dictionary:
+      key: steel
+      value: slate
     card:
       text: slate
       background: white

{basic_report-0.3.0 → basic_report-0.4.0}/src/basic_report/heatmap.py

@@ -9,7 +9,7 @@ from pathlib import Path
 from jinja2 import Environment, FileSystemLoader
 from . import TEMPLATE_DIR
 
-DATE_PATTERN = r"^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$"
+DATE_PATTERN = r'^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$'
 
 #-----------------------------------------------------------------------------------------------------------------------
 # region DOMAIN
@@ -20,7 +20,7 @@ DomainSortLiteral = Literal['asc', 'desc']
 @dataclass
 class CalendarDomain:
     """ Define the calendar domain
-    
+
     See https://cal-heatmap.com/docs/options/domain for all options and what they mean
     """
     type: DomainTypeLiteral = 'month'
@@ -30,9 +30,10 @@ class CalendarDomain:
     sort: DomainSortLiteral = 'asc'
 
     def __post_init__(self):
+        """ Check data input """
         checks = [
             ['type', DomainTypeLiteral],
-            ['sort', DomainSortLiteral]
+            ['sort', DomainSortLiteral],
         ]
 
         for name, literal  in checks:
@@ -42,8 +43,8 @@ class CalendarDomain:
                 msg = f'Domain parameter {name}={value} is not supported. Use one of {allowed}'
                 logger.error(msg)
                 raise ValueError(msg)
-        
-        if any([i < 0 for i in self.padding]):
+
+        if any(i < 0 for i in self.padding):
             msg = f'Domain padding={self.padding} cannot contain negative values, usage [T,R,B,L]'
             logger.error(msg)
             raise ValueError(msg)
@@ -57,15 +58,15 @@ LabelTextLiteral = Literal['YY', 'YYYY',
                            'd', 'dd', 'ddd', 'dddd',
                            'H', 'HH',
                            'h', 'hh',
-                           None]
+                           None] # noqa PYI061
 LabelPositionLiteral = Literal['top', 'right', 'bottom', 'left']
 LabelAlignLiteral = Literal['start', 'middle', 'end']
-LabelRotateLiteral = Literal['left', 'right', None]
+LabelRotateLiteral = Literal['left', 'right', None] # noqa PYI061
 
 @dataclass
 class CalendarLabel:
     """ Define the calendar label
-    
+
     See https://cal-heatmap.com/docs/options/domain/label for all options and what they mean
     """
     text: LabelTextLiteral | None = None
@@ -79,6 +80,7 @@ class CalendarLabel:
     font_weight: int = 450
 
     def __post_init__(self):
+        """ Check data input """
         checks = [
             ['text', LabelTextLiteral],
             ['position', LabelPositionLiteral],
@@ -93,14 +95,13 @@ class CalendarLabel:
                 msg = f'Label parameter {name}={value} is not supported. Use one of {allowed}'
                 logger.error(msg)
                 raise ValueError(msg)
-                     
+
         for k in ['width', 'height', 'font_size', 'font_weight']:
             value = self.__dict__[k]
             if value < 0:
                 msg = f'Label parameter `{k}={value}` cannot be negative.'
                 logger.error(msg)
                 raise ValueError(msg)
-                 
 
 #-----------------------------------------------------------------------------------------------------------------------
 # region SUB-DOMAIN
@@ -108,16 +109,16 @@ class CalendarLabel:
 SubdomainTypeLiteral = Literal['minute', 'hour', 'day', 'week', 'month', 'xDay', 'ghDay']
 SubdomainSortLiteral = Literal['asc', 'desc']
 SubdomainLabelLiteral = Literal['M', 'MM', 'MMM', 'MMMM',
-                                'D', 'DD', 
+                                'D', 'DD',
                                 'd', 'dd', 'ddd', 'dddd',
                                 'H', 'HH',
                                 'h', 'hh',
                                 'm', 'mm',
-                                None]
+                                None] # noqa PYI061
 @dataclass
 class CalendarSubDomain:
     """ Define the calendar sub domain
-    
+
     See https://cal-heatmap.com/docs/options/subDomainfor all options and what they mean
     """
     type: SubdomainTypeLiteral = 'day'
@@ -132,6 +133,7 @@ class CalendarSubDomain:
     background_color: str = '#ededed'
 
     def __post_init__(self):
+        """ Check data input """
         checks = [
             ['type', SubdomainTypeLiteral],
             ['sort', SubdomainSortLiteral],
@@ -154,15 +156,17 @@ class CalendarSubDomain:
                 raise ValueError(msg)
 
         if not re.match(r'^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$', self.background_color):
-            raise ValueError(f'Sub-Domain `background_color` is an invalid hex color: `{self.background_color}`')
-        
+            msg = f'Sub-Domain `background_color` is an invalid hex color: `{self.background_color}`'
+            logger.error(msg)
+            raise ValueError(msg)
+
 #-----------------------------------------------------------------------------------------------------------------------
 # region DATE
 #-----------------------------------------------------------------------------------------------------------------------
 @dataclass
 class CalendarDate:
     """ Define the calendar dates
-    
+
     See https://cal-heatmap.com/docs/options/date for all options and what they mean
     """
     start: str = dt.today().strftime('%Y-%m-%d')
@@ -173,21 +177,22 @@ class CalendarDate:
     timezone: str = 'Europe/Berlin'
 
     def __post_init__(self):
+        """ Check data input """
         for k in ['start', 'min' , 'max']:
             value =  self.__dict__[k]
             if value is not None and not re.match(DATE_PATTERN, value):
                 msg = f'Date parameter `{k}={value}` does not match requirements (YYYY-MM-DD).'
                 logger.error(msg)
                 raise ValueError(msg)
-                   
+
         if self.highlight is not None:
             for d in self.highlight:
                 if d != 'today' and not re.match(DATE_PATTERN, d):
                     msg = f'Element in date `highlight={d}` does not match requirements (YYYY-MM-DD) or `today`.'
                     logger.error(msg)
                     raise ValueError(msg)
-                
-        if not (0 <= self.weekstart <= 6):
+
+        if not (0 <= self.weekstart <= 6): # noqa PLR2004
             msg = f'Date `weekstart` must be int from 0 (Sunday) - 6 (Saturday), got {self.weekstart}'
             logger.error(msg)
             raise ValueError(msg)
@@ -197,17 +202,17 @@ class CalendarDate:
 #-----------------------------------------------------------------------------------------------------------------------
 ColorSchemeLiteral = Literal['YlOrRd', 'Blues', 'Greens', 'Greys', 'Oranges', 'Reds', 'Purples', 'Turbo', 'Viridis',
                              'Inferno', 'Magma', 'Plasma', 'Cividis', 'Warm', 'Cool', 'Cubehelix', 'BuPu', 'GnBu',
-                             'OrRd', 'PuBuGn', 'PuBu', 'PuRd', 'RdPu', 'YlGnBu', 'YlGn', 'YlOrBr', 'YlOrRd',
-                             'BrBG', 'PRGn', 'PiYG', 'PuOr', 'RdBu', 'RdGy', 'RdYlBu', 'RdYlGn', 'Spectral',
-                             'Rainbow', 'Sinebow', None]
-ColorInterpolateLiteral = Literal['rgb', 'hsl', 'lab', 'hcl', None]
+                             'OrRd', 'PuBuGn', 'PuBu', 'PuRd', 'RdPu', 'YlGnBu', 'YlGn', 'YlOrBr', 'BrBG', 'PRGn',
+                             'PiYG', 'PuOr', 'RdBu', 'RdGy', 'RdYlBu', 'RdYlGn', 'Spectral', 'Rainbow', 'Sinebow',
+                             None] # noqa PYI061 
+ColorInterpolateLiteral = Literal['rgb', 'hsl', 'lab', 'hcl', None] # noqa PYI061 
 ColorTypeLiteral = Literal['ordinal', 'linear', 'pow', 'sqrt', 'log', 'symlog', 'categorical', 'sequential', 'cyclical',
                            'threshold', 'quantile', 'quantize', 'diverging', 'diverging-log', 'diverging-pow',
                            'diverging-sqrt', 'diverging-symlog']
 @dataclass
 class CalendarColor:
     """ Define the calendar color scheme
-    
+
     See https://cal-heatmap.com/docs/options/scale for all options and what they mean
     """
     domain: list[float]
@@ -216,10 +221,10 @@ class CalendarColor:
     interpolate: ColorInterpolateLiteral = None
     type: ColorTypeLiteral = 'linear'
 
-    
     def __post_init__(self):
+        """ Check data input """
         if self.scheme is not None and self.range is not None:
-            msg = f'Color `scheme` and `range` provided. Use either one or the other.'
+            msg = 'Color `scheme` and `range` provided. Use either one or the other.'
             logger.error(msg)
             raise ValueError(msg)
 
@@ -242,12 +247,16 @@ class CalendarColor:
 #-----------------------------------------------------------------------------------------------------------------------
 @dataclass
 class CalendarMisc:
+    """ Define the calendar miscellaneous configuration
+
+    See https://cal-heatmap.com/docs/options for all options and what they mean
+    """
     id: str = 'hm-' + str(uuid.uuid4())
     range: int = 12
     animation_duration: int = 200
     vertical_orientation: bool = False
     tooltip_enabled: bool = True
-    tooltip_function: str = "predefined:date+value"
+    tooltip_function: str = 'predefined:date+value'
     tooltip_precision: int | None = None
     legend_width: int = 300
     legend_label: str | None = None
@@ -255,6 +264,7 @@ class CalendarMisc:
     legend_font_weight: int = 450
 
     def __post_init__(self):
+        """ Check data input """
         for k in ['animation_duration', 'range', 'legend_width', 'legend_font_size', 'legend_font_weight']:
             value = self.__dict__[k]
             if value < 0:
@@ -263,12 +273,12 @@ class CalendarMisc:
                 raise ValueError(msg)
 
         if self.tooltip_function.startswith('predefined:'):
-            
+
             if self.tooltip_precision is not None:
                 value = f'${{(value ?? 0).toFixed({self.tooltip_precision})}}'
             else:
                 value = '${value ?? 0}'
-            
+
             options = self.tooltip_function.removeprefix('predefined:')
             defined_options = ['value', 'date+value', 'datetime+value']
             if options == 'value':
@@ -278,7 +288,8 @@ class CalendarMisc:
             elif options == 'datetime+value':
                 tfn = f"${{dayjsDate.format('YYYY-MM-DD HH:mm:ss')}} : {value}"
             else:
-                msg = f'Unknown predefined tooltip function {self.tooltip_function}. Use one of `predefined:{defined_options}`'
+                msg = (f'Unknown predefined tooltip function {self.tooltip_function}.'
+                       f' Use one of `predefined:{defined_options}`')
                 logger.error(msg)
                 raise RuntimeError(msg)
 
@@ -291,11 +302,13 @@ DataTypeLiteral = Literal['date', 'timestamp']
 
 @dataclass
 class CalendarData:
+    """ The actual calendar data to be displayed """
     x: list[str]
     y: list[float]
     type: DataTypeLiteral = 'date'
 
     def __post_init__(self):
+        """ Check data input """
         checks = [
             ['type', DataTypeLiteral],
         ]
@@ -309,12 +322,14 @@ class CalendarData:
                 raise ValueError(msg)
 
     def get_table(self):
-        return [i for i in zip(self.x, self.y)]
-    
+        """ Return the dataset as a 2d list"""
+        return list(zip(self.x, self.y, strict=True))
+
 #-----------------------------------------------------------------------------------------------------------------------
 # region HEATMAP
-#-----------------------------------------------------------------------------------------------------------------------       
+#-----------------------------------------------------------------------------------------------------------------------
 class CalendarHeatmap:
+    """ A calendar heatmap to display in the report """
     def __init__(
             self,
             misc: CalendarMisc,
@@ -324,6 +339,16 @@ class CalendarHeatmap:
             date: CalendarDate,
             color: CalendarColor,
         ):
+        """ Create a new heatmap instance
+
+        Args:
+            misc (CalendarMisc): The miscellaneous configuration for the calendar heatmap
+            domain (CalendarDomain): The domain configuration for the calendar heatmap
+            label (CalendarLabel): The label configuration for the calendar heatmap
+            subdomain: (CalendarSubDomain): The subdomain configuration for the calendar heatmap
+            date (CalendarDate): The date configuration for the calendar heatmap
+            color (CalendarColor): The color configuration for the calendar heatmap
+        """
         self.misc: CalendarMisc = misc
         self.domain: CalendarDomain = domain
         self.label: CalendarLabel = label
@@ -337,6 +362,11 @@ class CalendarHeatmap:
 
     @classmethod
     def from_config_file(cls, cfg_file: str | Path):
+        """ Load a heatmap from a config file
+
+        Args:
+            cfg_file (str | Path): The path to the config file
+        """
         cfg = Path(cfg_file)
         with open(cfg, 'r') as f:
             hm_cfg = yaml.load(f, Loader=yaml.FullLoader)
@@ -347,14 +377,17 @@ class CalendarHeatmap:
             color = CalendarColor(**hm_cfg['color'])
             misc = CalendarMisc(**hm_cfg['misc'])
             return cls(misc, domain, label, subdomain, date, color)
-    
-    def set_color_range(self, range: list[float]):
-        self.color.domain = range
+
+    def set_color_range(self, rng: list[float]):
+        """ Set the color range of the heatmap """
+        self.color.domain = rng
 
     def set_data(self, x: list[str], y: list[str], data_type: str='date'):
+        """ Update the data to be plotted in the heatmap """
         self.data = CalendarData(x, y, data_type)
-         
+
     def make_button_div(self, direction: str):
+        """ Make the previous/next button div """
         if direction == 'next':
             template = self.jinja_env.get_template('heatmap/button_next.html')
         elif direction == 'previous':
@@ -363,18 +396,20 @@ class CalendarHeatmap:
             msg = 'Unknown button direction `{direction}`. Use either `next` or `previous`.'
             logger.error(msg)
             raise RuntimeError(msg)
-        
+
         html = template.render()
         return html
 
     def make_heatmap_div(self):
+        """ Make the heatmap div section """
         template = self.jinja_env.get_template('heatmap/heatmap.html')
         html = template.render(
             misc_id=self.misc.id,
         )
         return html
- 
+
     def make_legend_div(self):
+        """ Make the heatmap html legend section """
         template = self.jinja_env.get_template('heatmap/legend.html')
         html = template.render(
             misc_id=self.misc.id,
@@ -382,14 +417,15 @@ class CalendarHeatmap:
         return html
 
     def make_heatmap_script(self):
+        """ Make the heatmap html script section """
         template = self.jinja_env.get_template('heatmap/script.html')
         html = template.render(
-            # MISC   
+            # MISC
             misc_id=self.misc.id,
             misc_range=self.misc.range,
             misc_animation_duration=self.misc.animation_duration,
             misc_vertical_orientation=str(self.misc.vertical_orientation).lower(),
-            
+
             # TOOLTIP
             tooltip_enabled=str(self.misc.tooltip_enabled).lower(),
             tooltip_text=self.misc.tooltip_function,
@@ -431,7 +467,7 @@ class CalendarHeatmap:
             date_weekstart=self.date.weekstart,
             date_timezone=self.date.timezone,
 
-            # COLOR                   
+            # COLOR
             color_scheme=self.color.scheme,
             color_range=self.color.range,
             color_interpolate=self.color.interpolate,
@@ -445,6 +481,7 @@ class CalendarHeatmap:
         return html
 
     def make_heatmap(self):
+        """ Create the actual heatmap html """
         template = self.jinja_env.get_template('heatmap/base.html')
         html = template.render(
             heatmap_div=self.make_heatmap_div(),
@@ -456,6 +493,7 @@ class CalendarHeatmap:
         return html
 
     def make_css(self):
+        """ Create the CSS file for the heatmap """
         template = self.jinja_env.get_template('css/heatmap.css')
         return template.render(
             misc_id=self.misc.id,

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

@@ -19,7 +19,7 @@ from .heatmap import (
     CalendarDate,
     CalendarColor,
     CalendarMisc,
-    CalendarHeatmap
+    CalendarHeatmap,
 )
 
 #----------------------------------------------------------------------------------------------------------------------#
@@ -249,7 +249,7 @@ class ReportPage:
             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'))
@@ -261,6 +261,40 @@ class ReportPage:
                                alignment=alignment)
         self._update_content(html)
 
+    # region Dictionary
+    # -----------------
+    def add_dictionary(
+            self,
+            dictionary: dict[str,str] | list[list[str]],
+            key_color: str | None=None,
+            key_width: str | None=None,
+            value_color: str | None=None,
+        ):
+        """ Add a dictionary as key value list to the report
+
+        Args:
+            dictionary (dict[str, str] | list[list[str]]): The dictionary that should be added to the report. The key
+                will be right aligned in one column, whereas the values will be left aligned in the next column. If you
+                pass a list make sure it is a list of lists with 2 elements. The first will be assumed to be the key
+                the second represents the value
+            key_color (str | None): The text color for the keys
+            key_width (str | None): The width of the key column. Use any of the html specifications, e.g. 150px etc.
+            value_color (str | None): The color of the value text
+        """
+        key_width = default(key_width, None)
+        key_color = default(key_color, self.color_map.get_default_color('dictionary.key'))
+        value_color = default(value_color, self.color_map.get_default_color('dictionary.value'))
+
+        if isinstance(dictionary, dict):
+            dictionary = [[k,v] for k,v in dictionary.items()]
+
+        template = self.jinja_env.get_template('elements/dictionary.html')
+        html = template.render(dictionary=dictionary,
+                               key_color=key_color,
+                               key_width=key_width,
+                               value_color=value_color)
+        self._update_content(html)
+
     # region Table
     # ------------
     def add_table(
@@ -383,8 +417,23 @@ class ReportPage:
             color: CalendarColor | None = None,
             x: list[str] | None = None,
             y: list[float | int] | None = None,
-            custom_config: dict[str, Any] | None = None
-        ):      
+            custom_config: dict[str, Any] | None = None,
+        ):
+        """ Add a calendar heatmap to the report
+
+        Args:
+            misc (CalendarMisc | None): The miscellaneous configuration for the calendar heatmap
+            domain (CalendarDomain | None): The domain configuration for the calendar heatmap
+            label (CalendarLabel | None): The label configuration for the calendar heatmap
+            subdomain: (CalendarSubDomain | None): The subdomain configuration for the calendar heatmap
+            date (CalendarDate | None): The date configuration for the calendar heatmap
+            color (CalendarColor | None): The color configuration for the calendar heatmap
+            x (list[str] | None): The time data array, e.g., dates
+            y (list[float | int] | None): The corresponding value array
+            custom_config (dict[str, Any] | None): A custom config dict to easily override any defaults set in the
+                report. See the documentation for the calendar heatmap for an in depth discussion of the available
+                parameters
+        """
         # Incorporate the custom config
         if custom_config is None:
             custom_config = {}
@@ -406,13 +455,13 @@ class ReportPage:
             msg = 'Both x and y need to be set'
             logger.error(msg)
             raise RuntimeError(msg)
-        
+
         # Add to report
         hm = CalendarHeatmap(misc, domain, label, subdomain, date, color)
         hm.set_data(x=x, y=y)
 
         # We need to keep track of the heatmaps so we can properly add the style sheets later
-        self.cal_heatmaps.append(hm) 
+        self.cal_heatmaps.append(hm)
 
         self.add_custom_html_code(hm.make_heatmap())
 
@@ -563,7 +612,7 @@ class ReportPage:
     # ------------
     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
         """
@@ -603,7 +652,7 @@ class ReportPage:
             footer_text_color: str | None = None,
             footer_background_color: str | None = None,
             footer_border_color: str | None = None,
-            max_width: str='18rem'
+            max_width: str='18rem',
         ):
         """ Add a section title to the page
 
@@ -637,18 +686,26 @@ class ReportPage:
             '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')),
+            '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')),
+            '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')),
+            '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)
 

{basic_report-0.3.0 → basic_report-0.4.0}/src/basic_report/report.py

@@ -14,10 +14,8 @@ from .heatmap import (
     CalendarLabel,
     CalendarSubDomain,
     CalendarDate,
-    CalendarData,
     CalendarColor,
     CalendarMisc,
-    CalendarHeatmap
 )
 
 #----------------------------------------------------------------------------------------------------------------------#
@@ -130,7 +128,7 @@ class Report:
         for page in self.pages.values():
             for hm in page.cal_heatmaps:
                 css.append(hm.make_css())
-        
+
         css_file = output_dir / 'heatmap' / 'custom_cal_heatmap.css'
         css_file.write_text('\n'.join(css))
 
@@ -152,7 +150,7 @@ class Report:
 
     def dump(self, *, overwrite: bool=False):
         """ Save the report to file and add the CSS files
-        
+
         Args:
             overwrite (bool): If true an existing report dir will be deleted first. Use with caution, there are
                 no additional checks and balances implemented. If you rm your root its on you.
@@ -241,7 +239,7 @@ class Report:
                 chosen side
         """
         self.current.add_section_title(title_text, text_color, bar_color, alignment)
-        
+
     # Miscellaneous elements
     # ----------------------
     def add_text(self, text: str, color: Optional[str]=None, align: Optional[Literal['left', 'center', 'right']]=None):
@@ -328,7 +326,21 @@ class Report:
             y: list[float | int] | None = None,
             custom_config: dict[str, Any] | None = None,
         ):
-        """ Add a new calendar heatmap to the current page"""
+        """ Add a calendar heatmap to the report
+
+        Args:
+            misc (CalendarMisc | None): The miscellaneous configuration for the calendar heatmap
+            domain (CalendarDomain | None): The domain configuration for the calendar heatmap
+            label (CalendarLabel | None): The label configuration for the calendar heatmap
+            subdomain: (CalendarSubDomain | None): The subdomain configuration for the calendar heatmap
+            date (CalendarDate | None): The date configuration for the calendar heatmap
+            color (CalendarColor | None): The color configuration for the calendar heatmap
+            x (list[str] | None): The time data array, e.g., dates
+            y (list[float | int] | None): The corresponding value array
+            custom_config (dict[str, Any] | None): A custom config dict to easily override any defaults set in the
+                report. See the documentation for the calendar heatmap for an in depth discussion of the available
+                parameters
+        """
         self.current.add_calendar_heatmap(
             misc=misc,
             domain=domain,
@@ -349,6 +361,24 @@ class Report:
         """
         self.current.add_list(list_items)
 
+    def add_dictionary(
+            self,
+            dictionary: dict[str,str] | list[list[str]],
+            key_color: str | None=None,
+            key_width: str | None=None,
+            value_color: str | None=None,
+        ):
+        """ Add a dictionary as key value list to the report
+
+        Args:
+            dictionary (dict[str, str] | list[list[str]]): The dictionary that should be added to the report. The key
+                will be right aligned in one column, whereas the values will be left aligned in the next column
+            key_color (str | None): The text color for the keys
+            key_width (str | None): The width of the key column. Use any of the html specifications, e.g. 150px etc.
+            value_color (str | None): The color of the value text
+        """
+        self.current.add_dictionary(dictionary, key_color, key_width, value_color)
+
     def add_image(self,
             image_source: Union[str, Path],
             remove_source: Optional[bool]=None,
@@ -454,7 +484,7 @@ class Report:
             footer_text_color: str | None = None,
             footer_background_color: str | None = None,
             footer_border_color: str | None = None,
-            max_width: str='18rem'
+            max_width: str='18rem',
         ):
         """ Add a section title to the page
 

basic_report-0.4.0/src/basic_report/templates/elements/dictionary.html

@@ -0,0 +1,10 @@
+<div class="container mb-3">
+    <table style="border-collapse: collapse;">
+        {%- for item in dictionary %}
+            <tr>
+                <td class="text-{{ key_color }}" style="text-align: right; vertical-align: top"{% if key_width is not none %} width="{{ key_width }}"{% endif %}><strong>{{ item[0] }}</strong></td>
+                <td class="text-{{ value_color}}" style="padding-left: 1em">{{ item[1] }}</td>
+            </tr>
+        {%- endfor %}
+    </table>
+</div>

{basic_report-0.3.0 → basic_report-0.4.0}/src/basic_report/utils.py

@@ -107,12 +107,9 @@ class ColorMap:
         Returns:
             str - The color to be used
         """
-        if field.startswith('section_title'):
-            sub_field = field.removeprefix('section_title.')
-            color = self.config['default_color_profiles'][self.color_mode]['section_title'][sub_field]
-        elif field.startswith('card'):
-            sub_field = field.removeprefix('card.')
-            color = self.config['default_color_profiles'][self.color_mode]['card'][sub_field]
+        split_fields = field.split('.')
+        if split_fields[0] in ['section_title', 'card', 'dictionary']:
+            color = self.config['default_color_profiles'][self.color_mode][split_fields[0]][split_fields[1]]
         elif 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:

basic_report-0.3.0/src/basic_report/__init__.py

@@ -1,20 +0,0 @@
-from pathlib import Path
-
-# Make the package dir available in the module
-PACKAGE_DIR  = Path(__file__).parent
-PACKAGE_NAME = PACKAGE_DIR.name
-CONFIG_DIR   = PACKAGE_DIR / 'configs'
-TEMPLATE_DIR = PACKAGE_DIR / 'templates'
-SCRIPTS_DIR  = PACKAGE_DIR / 'css_and_scripts'
-
-from .report import Report as Report #noqa: E402
-from .heatmap import (
-    CalendarDomain,
-    CalendarLabel,
-    CalendarSubDomain,
-    CalendarDate,
-    CalendarData,
-    CalendarColor,
-    CalendarMisc,
-    CalendarHeatmap
-)