basic-report 0.4.2__tar.gz → 0.4.4__tar.gz

{basic_report-0.4.2 → basic_report-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-report
-Version: 0.4.2
+Version: 0.4.4
 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.4.2 → basic_report-0.4.4}/pyproject.toml

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

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/configs/default.yaml

@@ -84,6 +84,7 @@ default_color_profiles:
     report_ball: slate
     text: slate
     navbar: slate
+    download_button: light-gray
     section_title: 
       text: slate
       bars: slate
@@ -109,6 +110,7 @@ default_color_profiles:
     report_ball: slate
     text: slate
     navbar: slate
+    download_button: light-gray
     section_title: 
       text: slate
       bars: slate

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/heatmap.py

@@ -397,7 +397,7 @@ class CalendarHeatmap:
             logger.error(msg)
             raise RuntimeError(msg)
 
-        html = template.render()
+        html = template.render(misc_id=self.misc.id)
         return html
 
     def make_heatmap_div(self):

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/page.py

@@ -59,6 +59,7 @@ class ReportPage:
         self.rel_dir  = Path()
         self.abs_dir  = Path(report_dir)
         self.img_dir  = self.abs_dir / 'images'
+        self.file_dir = self.abs_dir / 'files'
         self.rel_file = self.rel_dir / self.file_name
         self.abs_file = self.abs_dir / self.file_name
         self.config = config
@@ -123,13 +124,10 @@ class ReportPage:
         ):
         """ Add a section containing errors/warnings/infos
 
-        If a report ball is provided it takes precedence over the other lists.
-
         Args:
             errors (Optional[list[str]]): List of errors encountered
             warnings (Optional[list[str]]): List of warnings encountered
             info (Optional[list[str]]): List of info encountered
-
         """
         errors   = default(errors, [])
         warnings = default(warnings, [])
@@ -501,6 +499,54 @@ class ReportPage:
         html = template.render(source=rel_image_path, responsive=responsive, center=center)
         self._update_content(html)
 
+    # region File
+    # ------------
+    def add_download_button(
+            self,
+            file_source: Union[str, Path],
+            remove_source: Optional[bool]=None,
+            button_color: Optional[bool]=None,
+            button_text: Optional[str]=None,
+            min_width: Optional[str]=None
+        ):
+        """ Add a download button to the page
+
+        Args:
+            file_source (Union[str, Path]): Path to file that needs to be added. The file will be copied to
+                report/page/files/
+            remove_source (Optional[bool]): If true the source will be deleted and we will only keep the copy in the
+                report dir
+            button_color (Optional[bool]): Color scheme for the download button
+            button_text (Optional[str]): Text written on the download button. If none is given the file name will be
+                used
+            min_width (Optional[str]): The minimum width of the download button
+        """
+        self.file_dir.mkdir(parents=True, exist_ok=True)
+        remove_source = default(remove_source, False)
+        button_color = default(button_color, self.color_map.get_default_color('download_button'))
+
+        min_width = default(min_width, '40px')
+
+        file_source = Path(file_source)
+        file_name = file_source.name
+
+        button_text = default(button_text, file_name)
+
+        file_dest = self.file_dir / file_name
+        shutil.copyfile(file_source, file_dest)
+        if remove_source:
+            file_source.unlink()
+
+        rel_file_path = self.rel_dir / 'files' / file_name
+        template = self.jinja_env.get_template('elements/download_button.html')
+        html = template.render(
+            file_path=rel_file_path,
+            button_color=button_color,
+            button_text=button_text,
+            min_width=min_width,
+        )
+        self._update_content(html)
+
     # region Custom HTML Code
     # -----------------------
     def add_custom_html_code(self, html: str):

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/report.py

@@ -198,9 +198,20 @@ class Report:
         """
         self.current.add_report_header(self.report_title, self.report_date, include_date, include_created_at, color)
 
-    def add_error_warning_info_section(self, **kwargs):
-        """ Add a section detailing errors, warnings, and info """
-        self.current.add_error_warning_info_section(**kwargs)
+    def add_error_warning_info_section(
+            self,
+            errors: Optional[list[str]]=None,
+            warnings: Optional[list[str]]=None,
+            info: Optional[list[str]]=None,
+        ):
+        """ Add a section containing errors/warnings/infos
+
+        Args:
+            errors (Optional[list[str]]): List of errors encountered
+            warnings (Optional[list[str]]): List of warnings encountered
+            info (Optional[list[str]]): List of info encountered
+        """
+        self.current.add_error_warning_info_section(errors, warnings, info)
 
     def add_header(self, header_text: str, color: Optional[str]=None):
         """ Add a header to the current page
@@ -395,6 +406,28 @@ class Report:
         """
         self.current.add_image(image_source, remove_source, responsive, center)
 
+    def add_download_button(
+            self,
+            file_source: Union[str, Path],
+            remove_source: Optional[bool]=None,
+            button_color: Optional[bool]=None,
+            button_text: Optional[str]=None,
+            min_width: Optional[str]=None
+        ):
+        """ Add a download button to the page
+
+        Args:
+            file_source (Union[str, Path]): Path to file that needs to be added. The file will be copied to
+                report/page/files/
+            remove_source (Optional[bool]): If true the source will be deleted and we will only keep the copy in the
+                report dir
+            button_color (Optional[bool]): Color scheme for the download button
+            button_text (Optional[str]): Text written on the download button. If none is given the file name will be
+                used
+            min_width (Optional[str]): The minimum width of the download button
+        """
+        self.current.add_download_button(file_source, remove_source, button_color, button_text, min_width)
+
     def add_local_link_to_page(self, page_name: str, link_name: str):
         """ Add a link to another page to the current page
 

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/templates/base.html

@@ -37,6 +37,16 @@
 <link rel="stylesheet" type="text/css" href="css_and_scripts/table.css" />
 <link rel="stylesheet" type="text/css" href="css_and_scripts/navbar.css" />
 
+<!-- SYMBOLS --!>
+<svg xmlns="http://www.w3.org/2000/svg" style="display:none">
+  <defs>
+    <symbol id="icon-download" viewBox="0 0 16 16">
+      <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5"/>
+      <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708z"/>
+    </symbol>
+  </defs>
+</svg>
+
 {{ head_content }}
 
 </head>

basic_report-0.4.4/src/basic_report/templates/elements/download_button.html

@@ -0,0 +1,8 @@
+<div class="container mb-3 justify-content-center">
+  <a href="{{ file_path }}" download class="btn btn-{{ button_color }}"  style="min-width: {{ min_width }};">
+    <svg width="16" height="16" fill="currentColor" class="mr-1">
+      <use href="#icon-download"/>
+    </svg>
+    {{ button_text }}
+  </a>
+</div>

basic_report-0.4.4/src/basic_report/templates/heatmap/button_next.html

@@ -0,0 +1 @@
+<button id="{{ misc_id }}-next-btn" class="btn btn-slate btn-no-focus">Next →</button>

basic_report-0.4.4/src/basic_report/templates/heatmap/button_prev.html

@@ -0,0 +1 @@
+<button id="{{ misc_id }}-prev-btn" class="btn btn-slate btn-no-focus">← Previous</button>

{basic_report-0.4.2 → basic_report-0.4.4}/src/basic_report/templates/heatmap/script.html

@@ -2,12 +2,12 @@
 document.addEventListener("DOMContentLoaded", function () {
 
     const cal = new CalHeatmap();
-    document.getElementById("prev-btn").addEventListener("click", function (e) {
+    document.getElementById("{{ misc_id }}-prev-btn").addEventListener("click", function (e) {
     e.preventDefault();
     cal.previous();
     });
 
-    document.getElementById("next-btn").addEventListener("click", function (e) {
+    document.getElementById("{{ misc_id }}-next-btn").addEventListener("click", function (e) {
     e.preventDefault();
     cal.next();
     });

basic_report-0.4.2/src/basic_report/templates/heatmap/button_next.html

@@ -1 +0,0 @@
-<button id="next-btn" class="btn btn-slate btn-no-focus">Next →</button>

basic_report-0.4.2/src/basic_report/templates/heatmap/button_prev.html

@@ -1 +0,0 @@
-<button id="prev-btn" class="btn btn-slate btn-no-focus">← Previous</button>