basic-report 0.1.0__tar.gz

basic_report-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+-----------
+Copyright (c) 2026 Björn Scholz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

basic_report-0.1.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: basic-report
+Version: 0.1.0
+Summary: A lightweight Python package for generating clean, professional static HTML reports.
+Keywords: html,report,static,responsive,website
+Author: Björn Scholz
+Author-email: Björn Scholz <bjorn.scholz@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pandas>=3.0.0
+Requires-Dist: pyyaml>=6.0.3
+Maintainer: Björn Scholz
+Maintainer-email: Björn Scholz <bjorn.scholz@gmail.com>
+Requires-Python: >=3.11
+Project-URL: Homepage, https://basic-report.scholz-and-scholz.com
+Project-URL: Documentation, https://basic-report.scholz-and-scholz.com
+Project-URL: Repository, https://gitlab.com/Nablaquabla/basic-report
+Project-URL: Issues, https://gitlab.com/Nablaquabla/basic-report/-/issues
+Project-URL: Changelog, https://gitlab.com/Nablaquabla/basic-report/-/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# Basic Report
+**basic-report** is a lightweight Python package for generating clean, professional static HTML reports with zero
+external dependencies. Built using elements of Bootstrap 4 (MIT licensed) and datatables (MIT licensed), it empowers you
+to create fully self-contained sites that can be served directly by any web server. The focus is set on simplicity - no
+oversized web framework, no database, no setup required.
+
+Design any reports entirely in Python using an intuitive top-to-bottom workflow. Simply add elements in the order they 
+should appear, and nest them naturally, e.g., tabs within columns, columns within tabs, or any combination you need. The
+API follows the logical flow of your document, making more complex layouts straightforward to build.
+
+Perfect for data scientists, analysts, and developers who need to create shareable, standalone reports without the
+overhead of modern web frameworks.
+
+## Quickstart
+### Installation
+
+Install the package from PyPI:
+```bash
+pip install basic-report
+```
+
+> [!tip]
+> We recommend using [uv](https://github.com/astral-sh/uv) for faster, more reliable dependency management
+> 
+> ```bash
+> uv add basic-report
+> ```
+
+### A Minimal Working Example Report
+
+The following example demonstrates the minimal setup required to generate a report including a report header:
+
+```python
+from basic_report import Report
+
+# Create a new report
+r = Report('output', 'Minimal Working Example', color_mode='light')
+r.add_report_header()
+r.add_text('This is a minimal working example')
+
+# Generate the static site
+r.dump()
+```
+
+Executing this script creates the following directory structure:
+```
+output/
+├── css_and_scripts/
+└── index.html
+```
+
+Open `index.html` in a web browser to view the report. No build step, compilation process, or server runtime is required.
+The output is a fully self-contained static site ready for distribution.
+
+**Next steps**: Follow the tutorial below to explore layouting and additional content or directly head over to the full
+[https://basic-report.scholz-and-scholz.com](full documentation) for a complete overview of available components.
+
+### Building A Proper Report
+
+This example demonstrates a ever so slightly more realistic use case, showcasing how you actually stack components to
+build your report.
+
+#### Initialize Your Report
+```python
+import datetime
+from pathlib import Path
+from basic_report import Report
+
+report_dir  = Path('example_report')
+report_name = 'System Status Report'
+report_date = datetime.date.today()
+
+r = Report(
+    report_dir,
+    report_name,
+    report_date,
+    color_mode='dark',
+)
+```
+
+#### Add a Professional Header
+Create a dominant header for your report. By default this header not only shows the name of the report, but also the
+date given during initialization. Additionally it also shows a sub-text which tells you when *exactly* the report
+files were created. However, you can easily deactivate the date options as follows:
+
+```python
+r.add_report_header(
+    include_date=False,
+    include_created_at=False,
+    color='steel',
+)
+```
+
+#### Display Structured Status Information
+
+Quickly surface critical information with color-coded status sections:
+```python
+errors = [
+    'Database connection timeout on rnd-server-03'
+]
+warnings = [
+    'Memory usage reached 75%',
+    'SSL certificate expires in 14 days',
+]
+info = [
+    'All backups completed successfully'
+]
+
+r.add_error_warning_info_section(errors=errors, warnings=warnings, info=info)
+```
+
+#### Create Multi-Column Layouts
+
+Construct responsive, structured layouts using containers such as columns:
+
+```python
+r.add_header('Performance Metrics', color='muffin')
+
+r.open_columns()
+r.add_column()
+r.add_text('Align text on the left', align='left')
+r.add_column()
+r.add_text('Align text in the center', color='cherry')
+r.add_column()
+r.add_text('Align text on the right', align='right')
+r.close_columns()
+```
+**Layout pattern**: Open a container element (e.g., columns, tabs, accordions), add content sequentially, then
+explicitly close the container. The library validates structural consistency and raises descriptive errors if elements
+remain unclosed.
+
+#### Create Multi-Page Reports
+
+For larger reports, create and manage multiple pages:
+
+```python
+# Create and populate a second page
+r.add_page('page2')
+r['page2'].add_header('Detailed Metrics')
+
+# Or set it as active and add content directly
+r.set_current_page('page2')
+r.add_text('Deep dive into performance trends...')
+```
+
+#### Add Navigation Links
+
+Link pages to provide intuitive navigation:
+
+```python
+r.add_local_link_to_page('main', '← Back to Overview')
+
+r.set_current_page('main')
+r.add_local_link_to_page('page2', 'View Detailed Metrics →')
+```
+
+#### Generate Your Report
+```python
+r.dump()
+```
+
+The result is a multi-page, self-contained static site with structured layout, responsive design, and integrated
+navigation. Everything generated entirely from Python code.
+
+![Example Report](docs/source/_static/tutorial_report_dark.png)

basic_report-0.1.0/README.md

@@ -0,0 +1,165 @@
+# Basic Report
+**basic-report** is a lightweight Python package for generating clean, professional static HTML reports with zero
+external dependencies. Built using elements of Bootstrap 4 (MIT licensed) and datatables (MIT licensed), it empowers you
+to create fully self-contained sites that can be served directly by any web server. The focus is set on simplicity - no
+oversized web framework, no database, no setup required.
+
+Design any reports entirely in Python using an intuitive top-to-bottom workflow. Simply add elements in the order they 
+should appear, and nest them naturally, e.g., tabs within columns, columns within tabs, or any combination you need. The
+API follows the logical flow of your document, making more complex layouts straightforward to build.
+
+Perfect for data scientists, analysts, and developers who need to create shareable, standalone reports without the
+overhead of modern web frameworks.
+
+## Quickstart
+### Installation
+
+Install the package from PyPI:
+```bash
+pip install basic-report
+```
+
+> [!tip]
+> We recommend using [uv](https://github.com/astral-sh/uv) for faster, more reliable dependency management
+> 
+> ```bash
+> uv add basic-report
+> ```
+
+### A Minimal Working Example Report
+
+The following example demonstrates the minimal setup required to generate a report including a report header:
+
+```python
+from basic_report import Report
+
+# Create a new report
+r = Report('output', 'Minimal Working Example', color_mode='light')
+r.add_report_header()
+r.add_text('This is a minimal working example')
+
+# Generate the static site
+r.dump()
+```
+
+Executing this script creates the following directory structure:
+```
+output/
+├── css_and_scripts/
+└── index.html
+```
+
+Open `index.html` in a web browser to view the report. No build step, compilation process, or server runtime is required.
+The output is a fully self-contained static site ready for distribution.
+
+**Next steps**: Follow the tutorial below to explore layouting and additional content or directly head over to the full
+[https://basic-report.scholz-and-scholz.com](full documentation) for a complete overview of available components.
+
+### Building A Proper Report
+
+This example demonstrates a ever so slightly more realistic use case, showcasing how you actually stack components to
+build your report.
+
+#### Initialize Your Report
+```python
+import datetime
+from pathlib import Path
+from basic_report import Report
+
+report_dir  = Path('example_report')
+report_name = 'System Status Report'
+report_date = datetime.date.today()
+
+r = Report(
+    report_dir,
+    report_name,
+    report_date,
+    color_mode='dark',
+)
+```
+
+#### Add a Professional Header
+Create a dominant header for your report. By default this header not only shows the name of the report, but also the
+date given during initialization. Additionally it also shows a sub-text which tells you when *exactly* the report
+files were created. However, you can easily deactivate the date options as follows:
+
+```python
+r.add_report_header(
+    include_date=False,
+    include_created_at=False,
+    color='steel',
+)
+```
+
+#### Display Structured Status Information
+
+Quickly surface critical information with color-coded status sections:
+```python
+errors = [
+    'Database connection timeout on rnd-server-03'
+]
+warnings = [
+    'Memory usage reached 75%',
+    'SSL certificate expires in 14 days',
+]
+info = [
+    'All backups completed successfully'
+]
+
+r.add_error_warning_info_section(errors=errors, warnings=warnings, info=info)
+```
+
+#### Create Multi-Column Layouts
+
+Construct responsive, structured layouts using containers such as columns:
+
+```python
+r.add_header('Performance Metrics', color='muffin')
+
+r.open_columns()
+r.add_column()
+r.add_text('Align text on the left', align='left')
+r.add_column()
+r.add_text('Align text in the center', color='cherry')
+r.add_column()
+r.add_text('Align text on the right', align='right')
+r.close_columns()
+```
+**Layout pattern**: Open a container element (e.g., columns, tabs, accordions), add content sequentially, then
+explicitly close the container. The library validates structural consistency and raises descriptive errors if elements
+remain unclosed.
+
+#### Create Multi-Page Reports
+
+For larger reports, create and manage multiple pages:
+
+```python
+# Create and populate a second page
+r.add_page('page2')
+r['page2'].add_header('Detailed Metrics')
+
+# Or set it as active and add content directly
+r.set_current_page('page2')
+r.add_text('Deep dive into performance trends...')
+```
+
+#### Add Navigation Links
+
+Link pages to provide intuitive navigation:
+
+```python
+r.add_local_link_to_page('main', '← Back to Overview')
+
+r.set_current_page('main')
+r.add_local_link_to_page('page2', 'View Detailed Metrics →')
+```
+
+#### Generate Your Report
+```python
+r.dump()
+```
+
+The result is a multi-page, self-contained static site with structured layout, responsive design, and integrated
+navigation. Everything generated entirely from Python code.
+
+![Example Report](docs/source/_static/tutorial_report_dark.png)

basic_report-0.1.0/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[project]
+name = "basic-report"
+version = "0.1.0"
+description = "A lightweight Python package for generating clean, professional static HTML reports."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "jinja2>=3.1.6",
+    "loguru>=0.7.3",
+    "pandas>=3.0.0",
+    "pyyaml>=6.0.3",
+]
+authors = [
+  {name = "Björn Scholz", email = "bjorn.scholz@gmail.com"},
+]
+maintainers = [
+  {name = "Björn Scholz", email = "bjorn.scholz@gmail.com"},
+]
+keywords = ["html", "report", "static", "responsive", "website"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+]
+license = "MIT"
+license-files = ["LICENSE.md"]
+
+[project.urls]
+Homepage = "https://basic-report.scholz-and-scholz.com"
+Documentation = "https://basic-report.scholz-and-scholz.com"
+Repository = "https://gitlab.com/Nablaquabla/basic-report"
+Issues = "https://gitlab.com/Nablaquabla/basic-report/-/issues"
+Changelog = "https://gitlab.com/Nablaquabla/basic-report/-/blob/main/CHANGELOG.md"
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = 'py313'
+extend-exclude = ["*.ipynb"]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+
+[tool.ruff.lint.pydocstyle]
+convention = 'google'
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = 'double'
+inline-quotes = 'single'
+
+[dependency-groups]
+dev = [
+    "furo>=2025.12.19",
+    "myst-parser>=4.0.1",
+    "ruff>=0.15.0",
+    "sphinx>=9.0.0",
+    "sphinx-copybutton>=0.5.2",
+]
+
+[tool.ruff.lint]
+select = [
+  'E',      # pycodestyle errors
+  'W',      # pycodestyle warnings
+  'F',      # Pyflakes
+  'D',      # pydocstyle
+  'B',      # flake8-bugbear
+  'A',      # flake8-builtins
+  'COM',    # flake8-commas
+  'C4',     # flake8-comprehensions
+  'EM',     # flake8-errmsg
+  'ISC',    # flake8-implicit-str-concat
+  'INP001', # flake8-no-pep420
+  'PIE',    # flake8-pie
+  'T20',    # flake8-print
+  'PYI',    # flake8-pyi
+  'Q',      # flake8-quotes
+  'RSE',    # flake8-raise
+  'SLF',    # flake8-self
+  'PTH',    # flake8-use-pathlib
+  'SIM',    # flake8-simplify
+  'S101',   # Use of assert detected
+  'S102',   # Use of exec detected
+  'S110',   # try-except-pass detected, consider logging the exception
+  'S112',   # try-except-continue detected, consider logging the exception
+  'FIX',    # Line contains TODO
+  'ERA',    # eradicate
+  'PL',     # Pylint
+  'PERF',   # Perflint
+  'RUF',
+]
+ignore = [
+  'D100',    # Missing docstring in public module
+  'D104',    # Missing docstring in public package
+  'D415',    # First line should end with a period
+  'D416',    # section-name-ends-in-colon
+  'D210',    # Surrounding whitespaces
+  'SIM108',  # Check for if-else-blocks that can be replaced with a ternary operator.
+  'PTH123',  # open()` should be replaced by `Path.open()
+  'PLR091',  # Too many x
+  'PLR1714', # Consider merging multiple comparisons
+  'PERF401', # Use a list comprehension to create a transformed list
+  'PERF203', # Checks for uses of except handling via try-except within for and while loops.
+  'RUF005',  # Consider `[*arr, 'new_item']` instead of concatenation
+]

basic_report-0.1.0/src/basic_report/__init__.py

@@ -0,0 +1,10 @@
+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

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

@@ -0,0 +1,185 @@
+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
+  light:
+    report_header: steel
+    header: slate
+    sub-header: slate
+    table: slate
+    report_ball: slate
+    text: slate
+    navbar: slate
+
+
+custom_colors:
+  slate:
+    border_dark: '#101416'
+    border_light: '#2c353a'
+    font_and_background: '#708090'
+    face_color: '#fff0f3'
+    link: '#abc4dc'
+    hover: '#374550'
+
+  cappuccino:
+    border_dark: '#1e1611'
+    border_light: '#63493a'
+    font_and_background: '#c09881'
+    face_color: '#edede9'
+    link: '#ffc394'
+    hover: '#1e1611'
+
+  forest:
+    border_dark: '#181818`'
+    border_light: '#374d37'
+    font_and_background: '#5d805d'
+    face_color: '#edede9'
+    link: '#c2c5aa'
+    hover: '#253325'
+
+  ocean:
+    border_dark: '#a9d6e5`'
+    border_light: '#012a4a'
+    font_and_background: '#2a6f97'
+    face_color: '#edede9'
+    link: '#a9d6e5'
+    hover: '#14364a'
+
+  cherry:
+    border_dark: '#fff0f3`'
+    border_light: '#590d22'
+    font_and_background: '#c9184a'
+    face_color: '#fff0f3'
+    link: '#ff8fa3'
+    hover: '#800f2f'
+
+  earth:
+    border_dark: '#100907'
+    border_light: '#44291e'
+    font_and_background: '#9d6b53'
+    face_color: '#fff0f3'
+    link: '#e6b8a2'
+    hover: '#50362a'
+
+  sunset:
+    border_dark: '#24100d'
+    border_light: '#582820'
+    font_and_background: '#f25c54'
+    face_color: '#fff0f3'
+    link: '#ffc16a'
+    hover: '#582820'
+
+  sunrise:
+    border_dark: '#251b0e'
+    border_light: '#634927'
+    font_and_background: '#f3b360'
+    face_color: '#fff'
+    link: '#ffe2bd'
+    hover: '#eb6758'
+
+  steel:
+    border_dark: '#17191c'
+    border_light: '#212529'
+    font_and_background: '#495057'
+    face_color: '#fff0f3'
+    link: '#ced4da'
+    hover: '#212529'
+
+  ice:
+    border_dark: '#0d161c'
+    border_light: '#6a9bc2'
+    font_and_background: '#f0f8ff'
+    face_color: '#4a7b9d'
+    link: '#a6b5c5'
+    hover: '#d2e4f9'
+
+  parchment:
+    border_dark: '#3e2f22'
+    border_light: '#cca67a'
+    font_and_background: '#fefbe3'
+    face_color: '#8b6a4d'
+    link: '#cca67a'
+    hover: '#e1cdad'