dl2-reports 0.1.0__tar.gz

dl2_reports-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: dl2-reports
+Version: 0.1.0
+Summary: A Python API for generating Datalys2 reports
+Author-email: kameronbrooks <kameron@creation-wasteland.com>
+Project-URL: Homepage, https://github.com/kameronbrooks/datalys2-reporting-python-api
+Project-URL: Bug Tracker, https://github.com/kameronbrooks/datalys2-reporting-python-api/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=1.0.0
+
+# Datalys2 Reporting Python API
+
+A Python library to build and compile interactive HTML reports using the Datalys2 Reporting framework.
+
+## Installation
+
+```bash
+pip install dl2-reports
+```
+
+## Quick Start
+
+```python
+import pandas as pd
+from dl2_reports import DL2Report
+
+# Create a report
+report = DL2Report(title="My Report")
+
+# Add data
+df = pd.DataFrame({"A": [1, 2], "B": [3, 4]})
+report.add_df("my_data", df, compress=True)
+
+# Add a page and visual
+page = report.add_page("Overview")
+page.add_row().add_kpi("my_data", value_column="A", title="Metric A")
+
+# Save to HTML
+report.save("report.html")
+```
+
+## Documentation
+
+For detailed information on available visuals and configuration, see [DOCUMENTATION.md](DOCUMENTATION.md).

dl2_reports-0.1.0/README.md

@@ -0,0 +1,34 @@
+# Datalys2 Reporting Python API
+
+A Python library to build and compile interactive HTML reports using the Datalys2 Reporting framework.
+
+## Installation
+
+```bash
+pip install dl2-reports
+```
+
+## Quick Start
+
+```python
+import pandas as pd
+from dl2_reports import DL2Report
+
+# Create a report
+report = DL2Report(title="My Report")
+
+# Add data
+df = pd.DataFrame({"A": [1, 2], "B": [3, 4]})
+report.add_df("my_data", df, compress=True)
+
+# Add a page and visual
+page = report.add_page("Overview")
+page.add_row().add_kpi("my_data", value_column="A", title="Metric A")
+
+# Save to HTML
+report.save("report.html")
+```
+
+## Documentation
+
+For detailed information on available visuals and configuration, see [DOCUMENTATION.md](DOCUMENTATION.md).

dl2_reports-0.1.0/dl2_reports/__init__.py

@@ -0,0 +1,3 @@
+from .dl2_reports import DL2Report
+
+__all__ = ["DL2Report"]

dl2_reports-0.1.0/dl2_reports/dl2_reports.py

@@ -0,0 +1,210 @@
+from __future__ import annotations
+from typing import Dict, List, Optional, Any
+import pandas as pd
+import json
+import datetime
+import gzip
+import base64
+
+
+class DL2Report:
+    class Visual:
+        def __init__(self, type: str, dataset_id: Optional[str] = None, **kwargs):
+            self.type = type
+            self.dataset_id = dataset_id
+            self.props = kwargs
+
+        def to_dict(self) -> Dict[str, Any]:
+            d = {
+                "type": self.type,
+                "elementType": "visual"
+            }
+            if self.dataset_id:
+                d["datasetId"] = self.dataset_id
+            
+            # Convert snake_case keys to camelCase for the JSON
+            for k, v in self.props.items():
+                camel_k = "".join(word.capitalize() if i > 0 else word for i, word in enumerate(k.split("_")))
+                d[camel_k] = v
+            return d
+
+    class Layout:
+        def __init__(self, direction: str = "row", **kwargs):
+            self.type = "layout"
+            self.direction = direction
+            self.children: List[DL2Report.Layout | DL2Report.Visual] = []
+            self.props = kwargs
+
+        def add_visual(self, type: str, dataset_id: Optional[str] = None, **kwargs) -> DL2Report.Visual:
+            visual = DL2Report.Visual(type, dataset_id, **kwargs)
+            self.children.append(visual)
+            return visual
+        
+        def add_layout(self, direction: str = "row", **kwargs) -> DL2Report.Layout:
+            layout = DL2Report.Layout(direction, **kwargs)
+            self.children.append(layout)
+            return layout
+
+        def add_kpi(self, dataset_id: str, value_column: str, title: str, **kwargs) -> DL2Report.Visual:
+            return self.add_visual("kpi", dataset_id, value_column=value_column, title=title, **kwargs)
+
+        def add_table(self, dataset_id: str, title: Optional[str] = None, **kwargs) -> DL2Report.Visual:
+            return self.add_visual("table", dataset_id, title=title, **kwargs)
+
+        def add_card(self, title: str, text: str, **kwargs) -> DL2Report.Visual:
+            return self.add_visual("card", None, title=title, text=text, **kwargs)
+
+        def add_pie(self, dataset_id: str, category_column: str, value_column: str, **kwargs) -> DL2Report.Visual:
+            return self.add_visual("pie", dataset_id, category_column=category_column, value_column=value_column, **kwargs)
+
+        def add_bar(self, dataset_id: str, x_column: str, y_columns: List[str], stacked: bool = False, **kwargs) -> DL2Report.Visual:
+            type = "stackedBar" if stacked else "clusteredBar"
+            return self.add_visual(type, dataset_id, x_column=x_column, y_columns=y_columns, **kwargs)
+
+        def add_scatter(self, dataset_id: str, x_column: str, y_column: str, **kwargs) -> DL2Report.Visual:
+            return self.add_visual("scatter", dataset_id, x_column=x_column, y_column=y_column, **kwargs)
+
+        def to_dict(self) -> Dict[str, Any]:
+            d = {
+                "type": "layout",
+                "direction": self.direction,
+                "children": [c.to_dict() for c in self.children]
+            }
+            for k, v in self.props.items():
+                camel_k = "".join(word.capitalize() if i > 0 else word for i, word in enumerate(k.split("_")))
+                d[camel_k] = v
+            return d
+
+    class Page:
+        def __init__(self, title: str, description: Optional[str] = None):
+            self.title = title
+            self.description = description
+            self.rows: List[DL2Report.Layout] = []
+
+        def add_row(self, direction: str = "row", **kwargs) -> DL2Report.Layout:
+            row = DL2Report.Layout(direction, **kwargs)
+            self.rows.append(row)
+            return row
+
+        def to_dict(self) -> Dict[str, Any]:
+            d = {
+                "title": self.title,
+                "rows": [r.to_dict() for r in self.rows]
+            }
+            if self.description:
+                d["description"] = self.description
+            return d
+
+    def __init__(self, title: str, description: str = "", author: str = ""):
+        self.title = title
+        self.description = description
+        self.author = author
+        self.pages: List[DL2Report.Page] = []
+        self.datasets: Dict[str, Dict[str, Any]] = {}
+        self.compressed_datasets: Dict[str, str] = {}
+        self.css_url = "https://cdn.jsdelivr.net/gh/kameronbrooks/datalys2-reporting@latest/dist/dl2-style.css"
+        self.js_url = "https://cdn.jsdelivr.net/gh/kameronbrooks/datalys2-reporting@latest/dist/datalys2-reports.min.js"
+        self.meta_tags: Dict[str, str] = {}
+
+    def add_df(self, name: str, df: pd.DataFrame, format: str = "records", compress: bool = False) -> DL2Report:
+        """
+        Adds a DataFrame to the report.
+        
+        :param name: Name of the dataset.
+        :param df: The DataFrame to add.
+        :param format: Data format ('records' or 'table').
+        :param compress: Whether to compress the data using gzip.
+        :return: The DL2Report instance.
+        """
+        columns = df.columns.tolist()
+        dtypes = []
+        for dtype in df.dtypes:
+            if pd.api.types.is_numeric_dtype(dtype):
+                dtypes.append("number")
+            elif pd.api.types.is_datetime64_any_dtype(dtype):
+                dtypes.append("date")
+            else:
+                dtypes.append("string")
+
+        if format == "records":
+            data = df.to_dict(orient="records")
+        else:
+            data = df.values.tolist()
+
+        dataset_entry = {
+            "id": name,
+            "format": format,
+            "columns": columns,
+            "dtypes": dtypes,
+            "data": data
+        }
+
+        if compress:
+            # Convert data to JSON string, then gzip, then base64
+            json_data = json.dumps(data)
+            compressed = gzip.compress(json_data.encode("utf-8"))
+            b64_data = base64.b64encode(compressed).decode("utf-8")
+            
+            script_id = f"compressed-data-{name}"
+            self.compressed_datasets[script_id] = b64_data
+            
+            dataset_entry["compression"] = "gzip"
+            dataset_entry["compressedData"] = script_id
+            dataset_entry["data"] = []
+            
+            # Enable GC for compressed data
+            self.set_meta("gc-compressed-data", "true")
+
+        self.datasets[name] = dataset_entry
+        return self
+
+    def add_page(self, title: str, description: Optional[str] = None) -> DL2Report.Page:
+        page = DL2Report.Page(title, description)
+        self.pages.append(page)
+        return page
+
+    def set_meta(self, name: str, content: str) -> DL2Report:
+        self.meta_tags[name] = content
+        return self
+
+    def compile(self) -> str:
+        report_data = {
+            "pages": [p.to_dict() for p in self.pages],
+            "datasets": self.datasets
+        }
+        report_data_json = json.dumps(report_data, indent=4)
+
+        meta_html = ""
+        for name, content in self.meta_tags.items():
+            meta_html += f'    <meta name="{name}" content="{content}">\n'
+
+        compressed_scripts = ""
+        for script_id, b64_data in self.compressed_datasets.items():
+            compressed_scripts += f'    <script id="{script_id}" type="text/b64-gzip">{b64_data}</script>\n'
+
+        html = f"""<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{self.title}</title>
+    <meta name="description" content="{self.description}">
+    <meta name="author" content="{self.author}">
+    <meta name="last-updated" content="{datetime.datetime.now().isoformat()}">
+{meta_html}
+    <link rel="stylesheet" href="{self.css_url}">
+</head>
+<body>
+{compressed_scripts}
+    <div id="root"></div>
+    <script id="report-data" type="application/json">
+{report_data_json}
+    </script>
+    <script src="{self.js_url}"></script>
+</body>
+</html>"""
+        return html
+
+    def save(self, filename: str):
+        with open(filename, "w", encoding="utf-8") as f:
+            f.write(self.compile())

dl2_reports-0.1.0/dl2_reports.egg-info/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: dl2-reports
+Version: 0.1.0
+Summary: A Python API for generating Datalys2 reports
+Author-email: kameronbrooks <kameron@creation-wasteland.com>
+Project-URL: Homepage, https://github.com/kameronbrooks/datalys2-reporting-python-api
+Project-URL: Bug Tracker, https://github.com/kameronbrooks/datalys2-reporting-python-api/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pandas>=1.0.0
+
+# Datalys2 Reporting Python API
+
+A Python library to build and compile interactive HTML reports using the Datalys2 Reporting framework.
+
+## Installation
+
+```bash
+pip install dl2-reports
+```
+
+## Quick Start
+
+```python
+import pandas as pd
+from dl2_reports import DL2Report
+
+# Create a report
+report = DL2Report(title="My Report")
+
+# Add data
+df = pd.DataFrame({"A": [1, 2], "B": [3, 4]})
+report.add_df("my_data", df, compress=True)
+
+# Add a page and visual
+page = report.add_page("Overview")
+page.add_row().add_kpi("my_data", value_column="A", title="Metric A")
+
+# Save to HTML
+report.save("report.html")
+```
+
+## Documentation
+
+For detailed information on available visuals and configuration, see [DOCUMENTATION.md](DOCUMENTATION.md).

dl2_reports-0.1.0/dl2_reports.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+dl2_reports/__init__.py
+dl2_reports/dl2_reports.py
+dl2_reports.egg-info/PKG-INFO
+dl2_reports.egg-info/SOURCES.txt
+dl2_reports.egg-info/dependency_links.txt
+dl2_reports.egg-info/requires.txt
+dl2_reports.egg-info/top_level.txt

dl2_reports-0.1.0/dl2_reports.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dl2_reports-0.1.0/dl2_reports.egg-info/requires.txt

@@ -0,0 +1 @@
+pandas>=1.0.0

dl2_reports-0.1.0/dl2_reports.egg-info/top_level.txt

@@ -0,0 +1 @@
+dl2_reports

dl2_reports-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dl2-reports"
+version = "0.1.0"
+authors = [
+  { name="kameronbrooks", email="kameron@creation-wasteland.com" },
+]
+description = "A Python API for generating Datalys2 reports"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "pandas>=1.0.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/kameronbrooks/datalys2-reporting-python-api"
+"Bug Tracker" = "https://github.com/kameronbrooks/datalys2-reporting-python-api/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["dl2_reports*"]

dl2_reports-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+