basic-report 0.1.0__py3-none-any.whl

basic_report-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,38 @@
+basic_report/__init__.py,sha256=ceLoM7D1Bitz8irxg4y4Kj1ShRaSbZ_QNN871OFSsgQ,319
+basic_report/configs/default.yaml,sha256=Md9rJSKeawjNla5wYsbgcK2paKtb_5eWt3vaSoz4kJM,5084
+basic_report/css_and_scripts/bootstrap.min.css,sha256=YLGeXaapI0_5IgZopewRJcFXomhRMlYYjugPLSyNjTY,155758
+basic_report/css_and_scripts/bootstrap.min.js,sha256=CjSoeELFOcH0_uxWu6mC_Vlrc1AARqbm_jiiImDGV3s,58072
+basic_report/css_and_scripts/dataTables.bootstrap4.min.js,sha256=hJ44ymhBmRPJKIaKRf3DSX5uiFEZ9xB_qx8cNbJvIMU,2085
+basic_report/css_and_scripts/jquery-3.3.1.slim.min.js,sha256=3edrmyuQ0w65f8gfBsqowzjJe2iM6n0nKciPUp8y-7E,69917
+basic_report/css_and_scripts/jquery.dataTables.min.js,sha256=t5ZQTZsbQi8NxszC10CseKjJ5QeMw5NINtOXQrESGSU,82411
+basic_report/css_and_scripts/popper.min.js,sha256=ZvOgfh-ptkpoa2Y4HkRY28ir89u_-VRyDE7sB7hEEcI,21004
+basic_report/page.py,sha256=qAJaJyh_jpTjCJnWqRj0HewrwrQgTtf6S4gTMpGP2xU,31187
+basic_report/report.py,sha256=qCmJ7wA_FRgIQiMx8xRp4laTnVMClsnmPOQsbBFg8O0,15623
+basic_report/templates/accordion.css,sha256=PTzF4YH7yPg6VLHfH3vgbejT-R83Jo_RR84BEHdSS64,616
+basic_report/templates/accordion.html,sha256=H_3SvvXj7LPXmtWmPEom0We7tJ3K76-EUy0A9fQAyqY,598
+basic_report/templates/base.html,sha256=MyKWdZhja4EWfIO7w9OR2UXkGeqMxmPxVxmqwvD66Gg,1665
+basic_report/templates/colors.css,sha256=TPpCGMRz7dGoX7a-W5ye6BIdjjpZ-uDLGFNJEgLvxL4,701
+basic_report/templates/columns.html,sha256=bMw3ldjKeODgBMBFxwqyv9yp65k43fhXGbvMzyGwnAg,165
+basic_report/templates/global_links.html,sha256=ZxZL6nX16enDE2syS9SlJS-OeabvCisa-b5mmkdRyU4,192
+basic_report/templates/header.html,sha256=KXYIK5tSozYCFkIVdk-mCMZQGik2ARRQbZ2v7yFazSM,188
+basic_report/templates/image.html,sha256=QGglJ3LPFxHbrddXCBFM9KEVaUUoBxUxBbP_8U4vQx0,285
+basic_report/templates/list.html,sha256=UjoBSebRuR8ehdebb-K7L3fUubrCXy0KzwAu2KRjFvk,122
+basic_report/templates/navbar.css,sha256=v6UoeMEUGmrLbSMPCw9TBsOf5NKxdI0maCfznXreo84,498
+basic_report/templates/navbar_left.html,sha256=qVbBoVpNUuk21YyhLLrmi7z5mNZq5kxMCzh7GoLfLA0,1045
+basic_report/templates/navbar_right.html,sha256=MXDkkzqtI4b7mfbQQ_wNtLLycvpIa5o7T0yzkmxTZ2Y,1045
+basic_report/templates/navbar_top.html,sha256=qRvF42sACOTUYmToiYH3MSgkDidLdlqbarfCQ7DUew8,821
+basic_report/templates/plot.html,sha256=E5YAypv1myboo8gAA0p0SMQ0ftdo3QMWAE4hlxp01RE,76
+basic_report/templates/report_ball_section.html,sha256=Mzl2ZUSDfFO8yXHe2G4MlSA4PBa3re5ttAt8FFXav1M,2576
+basic_report/templates/report_header.html,sha256=Xkmt8xT1c7KxI4nF7wHSQIr3GqzyNUhJkf_HFBoT-qs,220
+basic_report/templates/site.css,sha256=pEmZCGmm784-Aek6Los3JQuuNsJuRNvXo8lCbOGrgrY,108
+basic_report/templates/sublevel.html,sha256=PfN66cNrWDnzp7FKvjVU3bMeyly186T5Yvb_J2pUN_M,182
+basic_report/templates/table.css,sha256=HRr7JhbyRBdwf0dNgxuSt-wQPK6I7rtdy7LP-tgie-U,1568
+basic_report/templates/table.html,sha256=ndr57BU6AAS_V4PqZoFYqjKxBz6mhm-YyHNI2V6PBa8,1289
+basic_report/templates/tabs.css,sha256=eNNnDzV84PXn1GHNgWBv6Azwk7sZWUj05i6dLFJBwXw,572
+basic_report/templates/tabs.html,sha256=SFzyNXPaAjsKjo4n2g39KAdwA--p6Sh5tEKtqv632xk,826
+basic_report/templates/text.html,sha256=bUnC_opUlA3mbbXUfvbMCyFvWw52JlZbhNxYoTyjy-M,96
+basic_report/utils.py,sha256=MHh0T2n1KcsXKPob4tWsbGmUhkaieOnGks9p1TlRyUc,8492
+basic_report-0.1.0.dist-info/licenses/LICENSE.md,sha256=ME_QKQT2h9WhTZRd5B778qKCcq8tYPNasu3TQm5U4rU,1081
+basic_report-0.1.0.dist-info/WHEEL,sha256=o6xtdofIa8Zz80kUveEHMWeAWtEyZSzYS1bbyKDCgzA,80
+basic_report-0.1.0.dist-info/METADATA,sha256=1HUIv7d-JnwgGujqWRGSzVK95faVlWmE2YMYsrLdgFg,6247
+basic_report-0.1.0.dist-info/RECORD,,

basic_report-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.10.4
+Root-Is-Purelib: true
+Tag: py3-none-any

basic_report-0.1.0.dist-info/licenses/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.