# Report Creator

[![License](https://img.shields.io/badge/license-MIT-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)

[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. This is not meant to be a replacement for do-it-yourself HTML,
it's a tool to put together professional looking reports from python easily and quickly. The philosophy for layout is that components flow in
either the horizontal (`rc.Group()`) or Vertical (`rc.Block()`) direction.

Talk to this repo using [DeepWiki Report Creator](https://deepwiki.com/darenr/report_creator) 

Use the documentation in Cursor, Windsurf, Claude Desktop or another MCP Client via the [Context7 MCP](https://context7.com/darenr/report_creator) for example

```plaintext
Create an html report on this dataframe, use context7
```

## Features

### Data & Visualization

- **Deep Pandas Integration**: Native support for DataFrames in `Table`, `DataTable` (searcheable/sortable), and `Metric` components.
- **Interactive Plotting**: Full support for `Plotly` figures with a custom "RC" theme for professional-looking charts by default.
- **Matplotlib & Seaborn**: Automatic detection and rendering of `Matplotlib` and `Seaborn` objects, with consistent styling using a context manager.
- **Specialized Charts**: Built-in components for `Radar` charts, `Bar`, `Line`, `Pie`, `Scatter`, `Box`, and `Histogram`.
- **Advanced Metrics**: `Metric` and `MetricGroup` for KPI displays, including `EventMetric` for time-series frequency analysis.

### Content & Layout

- **Rich Layout System**: Flexible report structuring using `rc.Block()` (vertical) and `rc.Group()` (horizontal) stacks.
- **Modern UI Components**: Interactive elements like `Accordion`/`Collapse` sections and `Select` tabbed interfaces.
- **Superior Markdown**: Full GitHub Flavored Markdown (GFM) support, including Emojis, Math (LaTeX), and RST directives.
- **Diagrams as Code**: Native `Mermaid.js` support for flowcharts, sequence diagrams, and more, with built-in pan and zoom.

### Technical Capabilities

- **Syntax Highlighting**: Code blocks with support for multiple languages including `Sql`, `Python`, `Yaml`, and `Json`.
- **SQL Prettifier**: Heuristic formatting for SQL queries to improve readability in reports.
- **Smart Media Handling**: Images can be local, remote (fetched at build time), or Base64 encoded, with automatic styling.
- **Self-Contained Output**: Generates standalone HTML files that bundle only the required JavaScript dependencies (Plotly, DataTables, etc.).
- **Deterministic Styling**: Automatic, repeatable color generation for headings and labels to ensure visual consistency.

## Example

```python
import report_creator as rc

with rc.ReportCreator(
    title="My Report",
    description="My Report Description",
    footer="My Report Footer",
    accent_color="red"
) 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 -n rc -c conda-forge python=3.13
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 doc
make doc

# release new version
make release

# show list of make targets
make targets

```

## Get in touch

This project is under active development

- Report bugs via [GitHub Issues](https://github.com/darenr/report_creator/issues).

## Contributors

<a href="https://github.com/darenr/report_creator/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=darenr/report_creator" />
</a>

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=darenr/report_creator&type=Date)](https://www.star-history.com/#darenr/report_creator&Date)
