Skip to main content

Automation engine for report generation

Project description

Repen

Automation Engine for Report Generation in Python

Repen is a Python library for automated report generation that follows the same philosophy as Manim but for reports. It provides a declarative way to create beautiful, reproducible reports from various data sources.

✨ Features

  • Declarative API - Build reports using a clean, chainable API
  • Smart Adapters - Automatically convert common Python objects to report components
  • Multiple Outputs - HTML with themes, debug output, extensible renderers
  • Rich Components - Text with markdown-like syntax, tables, metrics, figures, images
  • Extensible - Easy to add new adapters, components, and renderers

🚀 Quick Start

Installation

pip install repen

Basic Usage

import matplotlib.pyplot as plt
import pandas as pd
from repen import Report

# Create a report
report = Report(title="Sales Analysis Q4 2023")

# Add content - Repen automatically adapts different data types
report.add("# Executive Summary")
report.add("Monthly sales performance with **key metrics** and trends.")

# Add metrics
report.add(
    {
        "Revenue": ("$1.2M", "USD", "highlight"),
        "Growth": ("15.2%", None, "success"),
        "Customers": (1250, "active", "default"),
    }
)

# Add a pandas DataFrame
df = pd.DataFrame(
    {
        "Month": ["Oct", "Nov", "Dec"],
        "Sales": [350000, 420000, 430000],
        "Growth": ["12%", "20%", "2.4%"],
    }
)
report.add(df)

# Add a matplotlib figure
fig, ax = plt.subplots()
ax.plot([1, 2, 3], [350, 420, 430])
ax.set_xlabel("Month")
ax.set_ylabel("Sales (K)")
ax.set_title("Sales Trend")
report.add(fig)

# Render and save
report.save("sales_report.html")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repen-0.1.0.tar.gz (83.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repen-0.1.0-py3-none-any.whl (94.0 kB view details)

Uploaded Python 3

File details

Details for the file repen-0.1.0.tar.gz.

File metadata

  • Download URL: repen-0.1.0.tar.gz
  • Upload date:
  • Size: 83.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.11 Linux/6.18.2-arch2-1

File hashes

Hashes for repen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4ed6ec2b78260dd3f9fff5949395d7eeaeb0206eaba94e5166ba505799870b01
MD5 addfd97514b1e16784a783d7a0407cc4
BLAKE2b-256 7ff52c2f2dcdae1ab5e705ab7d99696bdc91d121f6996c1d4883dccbd027e3e8

See more details on using hashes here.

File details

Details for the file repen-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: repen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 94.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.11 Linux/6.18.2-arch2-1

File hashes

Hashes for repen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa6d5199bafee384626ad4ee8d9fbf79c2057c4b56b1d7c9d9f6619362b52839
MD5 adfab7f5a36ee1c988e0e40178d94011
BLAKE2b-256 805467730f7bc6ade72ffd40c5e75b9ded44885eda901d4527e7a72539f8094c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page