report-creator 1.0.3__tar.gz

report_creator-1.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Daren Race
+
+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.

report_creator-1.0.3/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+include report_creator/templates/*

report_creator-1.0.3/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: report_creator
+Version: 1.0.3
+Summary: Produce self-contained HTML reports from Python
+Home-page: https://github.com/darenr/report_creator
+Author: Daren Race
+Author-email: daren.race@gmail.com
+License: Apache License, Version 2.0, January 2004
+Keywords: python,html,reports,report,creator,generator,markdown,yaml,plot,chart,table
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Report Creator
+
+[![License](https://img.shields.io/badge/license-Apache-blue.svg?style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
+[![PyPI Version](https://img.shields.io/pypi/v/report_creator.svg?style=for-the-badge&color=blue)](https://pypi.org/project/report_creator)
+[![Python Versions](https://img.shields.io/pypi/pyversions/report_creator.svg?logo=python&logoColor=white&style=for-the-badge)](https://pypi.org/project/report_creator)
+
+Library to assemble reports in HTML from various components using python
+
+## Features
+
+* [x] Good pandas/dataframe/table support
+* [x] Look modern
+* [x] Allows markdown as input for text blocks
+* [x] Allows html as input
+* [x] A few simple components for things like metrics ("Accuracy: 87%") from a triple of key, value
+* [x] Support for plotting figures, interactive `plotly` and `matplotlib`
+* [x] images (styled by the library)
+* [x] `json`/`yaml`/`python` code blocks with color syntax highlighting
+* [x] Support tabs
+* [x] Add support for any Jupyter widget, any object that renders in a notebook should render to a report
+* [x] Add built-in easy plotting that looks stylistically consistent with the report
+* [ ] Add bookmark anchors to blocks
+* [ ] Add a Table of Contents option based on labels of top-level-blocks
+* [ ] Youtube embeds rc.Video(url: str, label: str)
+* [ ] File attachments (downloadable from page)
+
+## Example
+
+```python3
+
+import report_creator as rc
+
+with rc.ReportCreator("My Report") as report:
+
+    view = rc.Block(
+        rc.Text("""It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness, it was the epoch of belief, it was the epoch of incredulity, it was the season of light, it was the season of darkness, it was the spring of hope, it was the winter of despair.""", 
+        label="Charles Dickens, A Tale of Two Cities"),
+        rc.Group(
+            rc.Metric(
+                heading="Answer to Life, The Universe, and Everything",
+                value="42",
+            ),
+            rc.Metric(
+                heading="Author",
+                value="Douglas Adams",
+            ),   
+        ),
+        rc.Bar(
+                px.data.medals_long(),
+                x="nation",
+                y="count",
+                dimension="medal",
+                label="Bar Chart - Olympic Medals",
+        ),
+        rc.Scatter(
+            df=px.data.iris(),
+            x="sepal_width",
+            y="sepal_length",
+            dimension="species",
+            marginal="histogram",
+            label="Scatter Plot - Iris",
+        ),
+    )
+
+    report.save(view, "report.html") 
+```
+
+## Development
+
+``` .python
+conda create --name rc python=3.9
+conda activate rc
+pip install -r requirements.txt -U
+
+# optionally for pretty html generation
+pip install beautifulsoup4 lxml
+
+# recommended installs for code hygiene
+pip install ruff
+
+# build "kitchen_sink" example
+make
+```
+
+## Dev Notes
+
+* **4/18/24 - no breaking changes**, all changes should go through standard deprecation policies
+* The Blocks/Groups use css [flex](https://css-tricks.com/snippets/css/a-guide-to-flexbox/).
+  * Blocks flow vertically (columns)
+* Groups flow horizontal (row).
+* To render math you'll need to `pip install md4mathjax`

report_creator-1.0.3/README.md

@@ -0,0 +1,91 @@
+# Report Creator
+
+[![License](https://img.shields.io/badge/license-Apache-blue.svg?style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
+[![PyPI Version](https://img.shields.io/pypi/v/report_creator.svg?style=for-the-badge&color=blue)](https://pypi.org/project/report_creator)
+[![Python Versions](https://img.shields.io/pypi/pyversions/report_creator.svg?logo=python&logoColor=white&style=for-the-badge)](https://pypi.org/project/report_creator)
+
+Library to assemble reports in HTML from various components using python
+
+## Features
+
+* [x] Good pandas/dataframe/table support
+* [x] Look modern
+* [x] Allows markdown as input for text blocks
+* [x] Allows html as input
+* [x] A few simple components for things like metrics ("Accuracy: 87%") from a triple of key, value
+* [x] Support for plotting figures, interactive `plotly` and `matplotlib`
+* [x] images (styled by the library)
+* [x] `json`/`yaml`/`python` code blocks with color syntax highlighting
+* [x] Support tabs
+* [x] Add support for any Jupyter widget, any object that renders in a notebook should render to a report
+* [x] Add built-in easy plotting that looks stylistically consistent with the report
+* [ ] Add bookmark anchors to blocks
+* [ ] Add a Table of Contents option based on labels of top-level-blocks
+* [ ] Youtube embeds rc.Video(url: str, label: str)
+* [ ] File attachments (downloadable from page)
+
+## Example
+
+```python3
+
+import report_creator as rc
+
+with rc.ReportCreator("My Report") as report:
+
+    view = rc.Block(
+        rc.Text("""It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness, it was the epoch of belief, it was the epoch of incredulity, it was the season of light, it was the season of darkness, it was the spring of hope, it was the winter of despair.""", 
+        label="Charles Dickens, A Tale of Two Cities"),
+        rc.Group(
+            rc.Metric(
+                heading="Answer to Life, The Universe, and Everything",
+                value="42",
+            ),
+            rc.Metric(
+                heading="Author",
+                value="Douglas Adams",
+            ),   
+        ),
+        rc.Bar(
+                px.data.medals_long(),
+                x="nation",
+                y="count",
+                dimension="medal",
+                label="Bar Chart - Olympic Medals",
+        ),
+        rc.Scatter(
+            df=px.data.iris(),
+            x="sepal_width",
+            y="sepal_length",
+            dimension="species",
+            marginal="histogram",
+            label="Scatter Plot - Iris",
+        ),
+    )
+
+    report.save(view, "report.html") 
+```
+
+## Development
+
+``` .python
+conda create --name rc python=3.9
+conda activate rc
+pip install -r requirements.txt -U
+
+# optionally for pretty html generation
+pip install beautifulsoup4 lxml
+
+# recommended installs for code hygiene
+pip install ruff
+
+# build "kitchen_sink" example
+make
+```
+
+## Dev Notes
+
+* **4/18/24 - no breaking changes**, all changes should go through standard deprecation policies
+* The Blocks/Groups use css [flex](https://css-tricks.com/snippets/css/a-guide-to-flexbox/).
+  * Blocks flow vertically (columns)
+* Groups flow horizontal (row).
+* To render math you'll need to `pip install md4mathjax`

report_creator-1.0.3/report_creator/__init__.py

@@ -0,0 +1,36 @@
+from .__meta__ import (
+    __authors__,
+    __contact__,
+    __description__,
+    __license__,
+    __version__,
+)
+from .report_creator import (
+    Bar,
+    Base,
+    Block,
+    Box,
+    Collapse,
+    DataTable,
+    Group,
+    Heading,
+    Histogram,
+    Html,
+    Image,
+    Json,
+    Line,
+    Markdown,
+    Metric,
+    MetricGroup,
+    Pie,
+    Python,
+    ReportCreator,
+    Scatter,
+    Select,
+    Separator,
+    Table,
+    Text,
+    Unformatted,
+    Widget,
+    Yaml,
+)

report_creator-1.0.3/report_creator/__meta__.py

@@ -0,0 +1,6 @@
+__version__ = "1.0.3"
+__authors__ = "Daren Race"
+__license__ = "Apache License, Version 2.0, January 2004"
+__contact__ = "daren.race@gmail.com"
+__license__ = "Apache License"
+__description__ = "Produce self-contained HTML reports from Python"