# Report Creator
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://pypi.org/project/report_creator)
[](https://pypi.org/project/report_creator)
[](https://pypi.org/project/report_creator)
[GitHub](https://github.com/darenr/report_creator) |
[PyPI](https://pypi.org/project/report_creator/) |
[Documentation](https://report-creator.readthedocs.io) |
[Issues](https://github.com/darenr/report_creator/issues) |
[Getting Started](https://report-creator.readthedocs.io/en/latest/getting_started.html)
Library to assemble reports in HTML from various components using python. Inspired by DataPane which is no longer maintained and targetted more interactive use cases.
## ⚡ Features
- [x] Good pandas/dataframe/table support
- [x] Look modern
- [x] Allows markdown as input for text blocks
- [x] Allows html as input
- [x] Components for things like metrics ("Accuracy: 87%") from a key & value
- [x] Support for plotting figures, interactive `plotly` and `matplotlib`
- [x] images (styled by the library) with an option to fetch at report build time (no fetch on render)
- [x] `json`/`yaml`/`python`/`java`/`ptolog` code blocks with color syntax highlighting
- [x] Support tab containers (not printer friendly)
- [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
- [x] Add option to change the report icon based on a github account avatar, or an image
- [x] Add a metric type for timeseries data which should some aggregate function of the data, and plot over time.
- [x] Add diagram component with Mermaid JS
- [x] Write documentation!
- [x] Add a status metric that supports up to a handful of k/v pairs (k=task, v=status)
- [x] Add bookmark anchors to blocks
- [x] Add Footer to report
- [x] Add accordion component
- [x] Add option for color logo (uses accent color param passed to ReportCreator ctor)
- [x] Clean up docs build, move requirements-doc into docs/environment.yaml "- -r requirements.txt"
- [ ] Add a Metric type for a softable list of key/values rendered like this [Percent of time](https://www.googlecloudcommunity.com/gc/image/serverpage/image-id/73682iEC88C630172A41FA/image-size/large)
- [ ] Progress component
- [ ] Add mistune plugin to allow gfk markdown icons - `:icon-name:`, for example `:pizza:`
- [ ] Add Venn diagram support (possibly with `matplotlib_venn`, or SVG)
- [ ] Add log file block [apachelogs](https://github.com/jwodder/apachelogs) with analytics
- [ ] Add Radar chart
- [ ] Add choropleth map plot type (maybe?)
- [ ] Youtube embeds rc.Video(url: str, label: str)
- [ ] File attachments (downloadable dataset from page)
- [ ] Switch logger to `logru`
## ⚡ Example
```python
import report_creator as rc
with rc.ReportCreator(
title="My Report",
description="My Report Description",
footer="My Report Footer",
) 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(
px.data.iris(),
x="sepal_width",
y="sepal_length",
dimension="species",
marginal="histogram",
label="Scatter Plot - Iris",
),
)
report.save(view, "report.html")
```
## 🤗 Development
```sh
conda create --name rc python=3.12
conda activate rc
make setup
# recommended for code hygiene
make format
# install as a local package:
python3 -m pip install -e .
# see dependency tree:
pipdeptree --exclude pip,pipdeptree,setuptools,wheel,twine
# build examples:
make examples
# build a specific example:
make examples EXAMPLES=examples/myreport.py
# run tests
make tests
# build docs
make docs
# release new version
make release
@ show list of make targets
make targets
```
Raw data
{
"_id": null,
"home_page": "https://github.com/darenr/report_creator",
"name": "report-creator",
"maintainer": "Daren Race",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "daren.race@gmail.com",
"keywords": "python, html, reports, report, creator, generator, markdown, yaml, plot, chart, table, blog",
"author": "Daren Race",
"author_email": "daren.race@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/9a/a72df54c9357b7fdb0f0665f32d9b654a273cebcc56066d9bf0adb98d748/report_creator-1.0.35.tar.gz",
"platform": null,
"description": "# Report Creator\n\n[](https://www.apache.org/licenses/LICENSE-2.0)\n[](https://pypi.org/project/report_creator)\n[](https://pypi.org/project/report_creator)\n[](https://pypi.org/project/report_creator)\n\n[GitHub](https://github.com/darenr/report_creator) | \n[PyPI](https://pypi.org/project/report_creator/) | \n[Documentation](https://report-creator.readthedocs.io) | \n[Issues](https://github.com/darenr/report_creator/issues) | \n[Getting Started](https://report-creator.readthedocs.io/en/latest/getting_started.html)\n\nLibrary to assemble reports in HTML from various components using python. Inspired by DataPane which is no longer maintained and targetted more interactive use cases.\n\n## \u26a1 Features\n\n- [x] Good pandas/dataframe/table support\n- [x] Look modern\n- [x] Allows markdown as input for text blocks\n- [x] Allows html as input\n- [x] Components for things like metrics (\"Accuracy: 87%\") from a key & value\n- [x] Support for plotting figures, interactive `plotly` and `matplotlib`\n- [x] images (styled by the library) with an option to fetch at report build time (no fetch on render)\n- [x] `json`/`yaml`/`python`/`java`/`ptolog` code blocks with color syntax highlighting\n- [x] Support tab containers (not printer friendly)\n- [x] Add support for any Jupyter widget, any object that renders in a notebook should render to a report\n- [x] Add built-in easy plotting that looks stylistically consistent with the report\n- [x] Add option to change the report icon based on a github account avatar, or an image\n- [x] Add a metric type for timeseries data which should some aggregate function of the data, and plot over time.\n- [x] Add diagram component with Mermaid JS\n- [x] Write documentation!\n- [x] Add a status metric that supports up to a handful of k/v pairs (k=task, v=status)\n- [x] Add bookmark anchors to blocks\n- [x] Add Footer to report\n- [x] Add accordion component\n- [x] Add option for color logo (uses accent color param passed to ReportCreator ctor)\n- [x] Clean up docs build, move requirements-doc into docs/environment.yaml \"- -r requirements.txt\"\n- [ ] Add a Metric type for a softable list of key/values rendered like this [Percent of time](https://www.googlecloudcommunity.com/gc/image/serverpage/image-id/73682iEC88C630172A41FA/image-size/large)\n- [ ] Progress component\n- [ ] Add mistune plugin to allow gfk markdown icons - `:icon-name:`, for example `:pizza:`\n- [ ] Add Venn diagram support (possibly with `matplotlib_venn`, or SVG)\n- [ ] Add log file block [apachelogs](https://github.com/jwodder/apachelogs) with analytics\n- [ ] Add Radar chart\n- [ ] Add choropleth map plot type (maybe?)\n- [ ] Youtube embeds rc.Video(url: str, label: str)\n- [ ] File attachments (downloadable dataset from page)\n- [ ] Switch logger to `logru`\n\n## \u26a1 Example\n\n```python\nimport report_creator as rc\n\nwith rc.ReportCreator(\n title=\"My Report\",\n description=\"My Report Description\",\n footer=\"My Report Footer\",\n) as report:\n view = rc.Block(\n rc.Text(\n \"\"\"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.\"\"\",\n label=\"Charles Dickens, A Tale of Two Cities\",\n ),\n rc.Group(\n rc.Metric(\n heading=\"Answer to Life, The Universe, and Everything\",\n value=\"42\",\n ),\n rc.Metric(\n heading=\"Author\",\n value=\"Douglas Adams\",\n ),\n ),\n rc.Bar(\n px.data.medals_long(),\n x=\"nation\",\n y=\"count\",\n dimension=\"medal\",\n label=\"Bar Chart - Olympic Medals\",\n ),\n rc.Scatter(\n px.data.iris(),\n x=\"sepal_width\",\n y=\"sepal_length\",\n dimension=\"species\",\n marginal=\"histogram\",\n label=\"Scatter Plot - Iris\",\n ),\n )\n\n report.save(view, \"report.html\")\n```\n\n## \ud83e\udd17 Development\n\n```sh\nconda create --name rc python=3.12\nconda activate rc\nmake setup\n\n# recommended for code hygiene\nmake format\n\n# install as a local package:\npython3 -m pip install -e .\n\n# see dependency tree:\npipdeptree --exclude pip,pipdeptree,setuptools,wheel,twine\n\n# build examples:\nmake examples\n\n# build a specific example:\nmake examples EXAMPLES=examples/myreport.py\n\n# run tests\nmake tests\n\n# build docs\nmake docs\n\n# release new version\nmake release\n\n@ show list of make targets\nmake targets\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Create self-contained HTML reports from Python.",
"version": "1.0.35",
"project_urls": {
"Homepage": "https://github.com/darenr/report_creator"
},
"split_keywords": [
"python",
" html",
" reports",
" report",
" creator",
" generator",
" markdown",
" yaml",
" plot",
" chart",
" table",
" blog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf1c2234165294a47d70b44a1949938aebe743cab11c2ed54299719382afeb78",
"md5": "1f7e96c50c307d489e96edb339ce9bee",
"sha256": "d04851f852878008742a96f01ea431f1274c05a85709ece978441cc8189af23f"
},
"downloads": -1,
"filename": "report_creator-1.0.35-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f7e96c50c307d489e96edb339ce9bee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23456,
"upload_time": "2024-12-17T01:05:04",
"upload_time_iso_8601": "2024-12-17T01:05:04.749691Z",
"url": "https://files.pythonhosted.org/packages/bf/1c/2234165294a47d70b44a1949938aebe743cab11c2ed54299719382afeb78/report_creator-1.0.35-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "469aa72df54c9357b7fdb0f0665f32d9b654a273cebcc56066d9bf0adb98d748",
"md5": "3f5a36ff5b01855a721c73b9bb46b14d",
"sha256": "1c08ac6ca01205420eb8753eb51f6920050a7c8341bf2d60195acc217e83c71b"
},
"downloads": -1,
"filename": "report_creator-1.0.35.tar.gz",
"has_sig": false,
"md5_digest": "3f5a36ff5b01855a721c73b9bb46b14d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 27972,
"upload_time": "2024-12-17T01:05:07",
"upload_time_iso_8601": "2024-12-17T01:05:07.098722Z",
"url": "https://files.pythonhosted.org/packages/46/9a/a72df54c9357b7fdb0f0665f32d9b654a273cebcc56066d9bf0adb98d748/report_creator-1.0.35.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 01:05:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "darenr",
"github_project": "report_creator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pandas",
"specs": []
},
{
"name": "pyarrow",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "mistune",
"specs": [
[
">=",
"3.0.2"
]
]
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "plotly",
"specs": []
},
{
"name": "plotly-express",
"specs": []
},
{
"name": "Jinja2",
"specs": []
},
{
"name": "humanize",
"specs": []
},
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "python-dateutil",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "pillow",
"specs": []
},
{
"name": "md4mathjax",
"specs": []
},
{
"name": "emoji",
"specs": []
},
{
"name": "setuptools",
"specs": []
}
],
"lcname": "report-creator"
}
JSON
