Skip to main content

YAML-driven Excel financial model generator

Project description

excel-model

CI License: MIT

YAML-driven Excel financial model generator.

Build professional financial models (P&L, DCF, Budget vs Actuals, Scenario Analysis) from declarative YAML specs. Generates .xlsx workbooks with named ranges, styled sheets, and Excel formulas using openpyxl.

Documentation

Installation

pip install excel-model

Or for development:

pixi install

Quick Start

CLI

# Build a P&L model
excel-model build --spec model.yaml --output model.xlsx --mode batch

# Validate a spec
excel-model validate --spec model.yaml

# Describe what a spec would produce
excel-model describe --spec model.yaml --format text

Python API

from excel_model.spec_loader import load_spec
from excel_model.validator import validate_spec
from excel_model.excel_writer import build_workbook
from excel_model.config import load_style

spec = load_spec("model.yaml")
errors = validate_spec(spec)
assert not errors

style = load_style(None)  # uses bundled defaults
build_workbook(spec=spec, inputs=None, output_path="model.xlsx", style=style)

Model Types

Type Description
p_and_l Profit & Loss statement
dcf Discounted Cash Flow valuation
budget_vs_actuals Budget vs Actuals comparison
scenario Multi-scenario analysis (Base/Bull/Bear)
comparison Cross-entity comparison

Formula Types

21 built-in formula types including growth_projected, pct_of_revenue, sum_of_rows, subtraction, ratio, discounted_pv, terminal_value, npv_sum, variance, variance_pct, constant, custom, and more.

Configuration

Style config controls Excel formatting (colors, fonts, number formats). A bundled default is included; override with --style:

header_fill_hex: "1F3864"
header_font_color: "FFFFFF"
font_name: "Calibri"
font_size: 10
number_format_currency: '#,##0'
number_format_percent: '0.0%'

Looking for Financial Modeling Input

This library was built by a software engineer, not a financial analyst. The model structures, formula types, and default assumptions reflect a developer's interpretation of common financial models.

If you work in finance, FP&A, investment banking, or accounting, your input would be incredibly valuable:

  • Are the formula types correct? Do growth_projected, pct_of_revenue, discounted_pv, and terminal_value follow standard conventions?
  • Missing model patterns? Are there common financial model structures (e.g., waterfall, three-statement, LBO) that should be supported?
  • Named range conventions -- do the Excel named range naming patterns match what analysts expect?
  • Number formatting -- are the default currency/percent/integer formats appropriate for professional models?
  • Scenario analysis -- does the base/bull/bear override pattern match how scenarios are typically structured?

Please open an issue with the type:feat label, or start a discussion. All feedback is welcome, from quick corrections to detailed model reviews.

License

MIT

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

excel_model-0.1.1.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

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

excel_model-0.1.1-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file excel_model-0.1.1.tar.gz.

File metadata

  • Download URL: excel_model-0.1.1.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for excel_model-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c448175386bba927db947689d2dab2a4e3119dc4fc9723686f86ffb998034cde
MD5 f624b19ec6de9c2f9dd5b2c4cd8e558f
BLAKE2b-256 e5f71410e19859edaff3d6b6791bc20c3ca2645f44b776241698e953fc204d3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for excel_model-0.1.1.tar.gz:

Publisher: publish.yml on neuralsignal/excel-model

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file excel_model-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: excel_model-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for excel_model-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 77a66be45605c9be33d46002444b5fe2ed4ee9768333d0d939c6f7f312026df7
MD5 bab8f3352b061c26c5bbdfc973a2f7c3
BLAKE2b-256 e65f47950caf4de8d4b11e7f047a2eeff20d197864734a49df1e411ac8f1beef

See more details on using hashes here.

Provenance

The following attestation bundles were made for excel_model-0.1.1-py3-none-any.whl:

Publisher: publish.yml on neuralsignal/excel-model

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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