autorpt 0.1.1

Automated budget report generator for grant management with Excel input and Word output

autorpt

Automated budget report generator for grant management with Excel input and Word output

• Free software: MIT license
• Documentation: https://VRConservation.github.io/autorpt

Features

• Excel Budget Input: Load budget data from budget.xlsx with columns for Task, Budgeted, Spent, and Remaining amounts
• Automated Report Generation: Creates professional Word documents with tables, charts, and formatted content
• Customizable Content: Use content.md to customize report sections (Summary, Deliverables Progress, Challenges, etc.)
• Command Line Interface: Run from terminal with options for input/output files
• Python API: Use programmatically in your own scripts
• Visual Charts: Automatically generates budget comparison charts
• Professional Formatting: Clean, business-ready Word document output

Quick Start

Installation

pip install autorpt

Basic Usage

1. Prepare your budget file: Ensure budget.xlsx exists with columns:

   • Task: Description of budget items
   • Budgeted: Total budgeted amounts
   • Spent: Amount spent to date
   • Remaining: Remaining budget

2. Generate report:

   # Command line (uses budget.xlsx by default)
   autorpt
   
   # Or specify custom files
   autorpt --input my_budget.xlsx --output custom_report.docx
   

3. Python API:

   import autorpt
   
   # Simple usage
   autorpt.generate_report()
   
   # Custom files
   autorpt.generate_report('my_budget.xlsx', 'my_report.docx')
   

File Structure

Your project directory should contain:

your_project/
├── budget.xlsx          # Your budget data (required)
├── content.md           # Custom content sections (optional)
└── reports/             # Generated reports folder (auto-created)

Customizing Content

Create a content.md file to customize report sections:

# Summary

Your custom summary content here...

# Deliverables Progress

-   Custom deliverable 1
-   Custom deliverable 2

# Challenges

Current project challenges...

# Next Period Activities

Planned activities...

Command Line Options

autorpt --help
autorpt --input budget.xlsx --output report.docx --verbose
autorpt --pdf                     # Generate report + PDF
autorpt --pdf-only                # Convert latest report to PDF
autorpt --pdf-all                 # Convert all reports to PDF

• --input, -i: Input Excel file (default: budget.xlsx)
• --output, -o: Output Word document filename
• --pdf, -p: Also convert the report to PDF
• --pdf-only: Convert most recent report to PDF (no new generation)
• --pdf-all: Convert all Word reports to PDF
• --verbose, -v: Enable verbose output

PDF Conversion

autorpt includes built-in PDF conversion capabilities. See the pdf/ folder for:

• Complete PDF documentation (pdf/PDF_README.md)
• Helper scripts for easy PDF operations
• Simple command aliases setup

Quick PDF usage:

# Built-in commands
autorpt --pdf                     # Generate new report + PDF
autorpt --pdf-only                # Convert latest report to PDF

# Helper scripts (from pdf/ folder)
.\pdf\setup-aliases.ps1           # Set up simple aliases
pdf-latest                        # Then use: convert latest to PDF
pdf-new                           # Generate new report + PDF

Output

The package generates:

• Professional Word document in reports/ folder
• Optional PDF conversion of reports
• Budget comparison charts
• Automatically formatted tables
• Summary statistics and key insights