Intelligent financial modeling platform for small businesses
Project description
WACCY
Intelligent Financial Modeling Platform for Small Businesses
WACCY is an intelligent financial modeling platform designed to automatically extract, parse, classify, and synthesize business data from diverse sources to generate sophisticated, production-grade financial models and operating analyses. The platform's primary focus is on small businessesโfrom sole proprietorships to growing companiesโthat struggle with messy, incomplete, and poorly-maintained financial records.
Unlike large enterprises with dedicated accounting teams, small businesses often have inconsistent record-keeping, ambiguous account classifications, incomplete data, and limited financial infrastructure. WACCY transforms this raw, often chaotic business data into comprehensive, auditable, and decision-ready financial models that adhere to institutional-quality standards.
Current Status
WACCY is an early package, but the v0.1.0 vertical slice now implements a fixture-first financial modeling path:
- QBO/QuickBooks-shaped fixture extraction through
QuickBooksExtractor - a small typed QuickBooks OAuth/report puller in
waccy-quickbooks - EDGAR/XBRL-shaped fixture extraction through
EdgarExtractor - normalized, mapped, and validated financial datasets
- deterministic source-to-WACCY account mapping with override support
- three-statement model construction with reconciliation checks
- XLSX export with the three required workbook sheets
- pandas DataFrame export for follow-on modeling outside WACCY
The QuickBooks helper pulls raw QBO company info, chart of accounts, and reports, then normalizes those reports into WACCY source records. Live EDGAR fetching and richer filing parsing remain planned. The first milestone remains focused on hardening the QBO/EDGAR path into the v0.1.0 release, tracked by issue #15.
Quick Start
Installation
WACCY uses uv, the modern Python package manager. Install the core platform:
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install WACCY core platform
uv pip install waccy
# Install with core extensions (QuickBooks Online and SEC EDGAR)
uv pip install "waccy[quickbooks,edgar]"
# Or install individual extensions
uv pip install waccy-quickbooks
uv pip install waccy-edgar
What Works Today
The current package can discover installed extractor entry points and build source-agnostic three-statement outputs from fixture data:
from waccy.extraction import ExtractorRegistry
registry = ExtractorRegistry()
available_sources = registry.list_extractors()
print(f"Available data sources: {available_sources}")
Implemented v0.1.0 components include:
- fixture-first QBO and EDGAR extraction
- typed QBO OAuth token cache, raw report pulling, and deterministic report normalization
- standard account ontology and deterministic aliases
- mapping, validation, reconciliation, and quality diagnostics
- three-statement model building
- spreadsheet export
- pandas DataFrame handoff for external modeling workflows
- local and CI quality gates with BDD outcome specs
Still planned:
- full live QuickBooks product workflow beyond report pulling and normalization
- live EDGAR fetching and richer filing parsing
- LLM-assisted classification and confidence scoring beyond placeholders
- advanced model types such as DCF, LBO, M&A, and specialized industry models
Planned Capabilities
๐ค AI-Powered Data Extraction & Classification
- Intelligent Account Mapping: LLM-enhanced classification for ambiguous account names and inconsistent categorizations
- Missing Data Inference: Patterns learned from high-quality sources (EDGAR filings) to infer missing information
- Causal Chain Recognition: Understands how financial events cascade through statements
- Terminology Normalization: Maps equivalent concepts across different naming conventions
- Confidence Scoring: Every classification includes a confidence score for quality assessment
๐๏ธ Standardized Financial Ontology
- WACCY Standard Chart of Accounts: Comprehensive, standardized classification ontology
- Universal Mapping: All data sources map to the same standard accounts for consistency
- Industry Templates: Pre-configured extensions for SaaS, manufacturing, retail, real estate, and more
- Quality Quantification: Standardized ontology enables measurement of data quality and model reliability
๐ Institutional-Quality Financial Models
- 3-Statement Integrated Models: Income statement, balance sheet, and cash flow with full balancing
- DCF Valuation Models: Detailed free cash flow construction, terminal value analysis, WACC calculation
- Trading Comparables: Peer company analysis with multiple calculation and benchmarking
- Transaction Comparables: Precedent M&A transaction analysis
- LBO Models: Leveraged buyout analysis with returns calculation and debt schedules
- M&A Models: Accretion/dilution analysis with purchase accounting
- Specialized Models: SaaS cohort models, REIT models, project finance, cap tables, and more
๐ Modular Extension Architecture
- Core Platform: Focused core with QuickBooks Online and SEC EDGAR as primary data sources
- Extensible Design: Community-developed extension packages for additional data sources
- Entry Point Discovery: Automatic discovery of extensions via Python entry points
- Simple Installation: Install only the extensions you need
๐ Advanced Forecasting & Analysis
- Driver-Based Forecasting: Revenue builds from price ร volume, units ร ARPU, cohort models
- Working Capital Modeling: DSO, DIO, DPO analysis with seasonality adjustments
- Debt & Interest Modeling: Revolver mechanics, amortization schedules, cash sweep waterfalls
- Tax Modeling: Effective tax rates, DTAs/DTLs, NOL utilization tracking
- Sensitivity Analysis: Comprehensive scenario modeling and tornado charts
โ Data Quality & Validation
- Pandera Validation: Schema-based validation for extracted data
- Mapping Confidence Scores: Quantify the reliability of account mappings
- Reconciliation Checks: Cross-referencing between sources and balance checks
- Audit Trails: Every data point traceable to source with full provenance
๐ Professional Model Outputs
- Spreadsheet Export: Production-ready workbook models with proper formatting
- Professional Architecture: Modular tab structures, consistent time axis, clear sign conventions
- Color Conventions: Inputs in blue, calculations in black, outputs in green
- Balance Checks: Built-in reconciliation tables and error flags
- Scenario Tooling: Data tables for sensitivity analysis, scenario toggles, goal seek integration
Fixture-First Workflow
The v0.1.0 workflow starts with fixture-shaped records. Live API configuration can be added later without changing the downstream modeling contract.
from waccy.modeling import ModelBuilder
from waccy_quickbooks.extractor import QuickBooksExtractor
fixture = {
"entity_name": "Example Co",
"periods": [
{"label": "2024", "start_date": "2024-01-01", "end_date": "2024-12-31"}
],
"records": [
{"name": "Sales", "period": "2024", "amount": 1000, "statement": "income_statement"},
{"name": "Cost of Goods Sold", "period": "2024", "amount": 400, "statement": "income_statement"},
{"name": "Checking", "period": "2024", "amount": 100, "statement": "balance_sheet"},
],
}
extracted_data = QuickBooksExtractor().extract({"fixture": fixture})
builder = ModelBuilder()
model = builder.build_three_statement_model(extracted_data)
builder.export_to_sheets(model, output_path="financial_model.xlsx")
Target Output
Standardized Account Mapping
Source Account: "Sales Revenue" (QuickBooks)
Mapped To: Revenue - Product Sales (WACCY Standard)
Confidence: 0.95
Validation: โ
Transaction patterns match revenue recognition
v0.1.0 Workbook Structure
Financial Model.xlsx
โโโ Income Statement
โโโ Balance Sheet
โโโ Cash Flow Statement
๐ Core Data Sources
QuickBooks Online (QBO)
Primary Data Source - The accounting system most commonly used by small businesses.
Implemented for v0.1.0:
- Fixture-first extraction path for chart of accounts and statement data
- Account normalization and source provenance
- Skeptical treatment of source classifications with validation
Planned after v0.1.0:
- Real-client path documented behind explicit credentials/configuration
SEC EDGAR
Pattern Learning & Reference Data - High-quality financial data for learning and benchmarking.
Implemented for v0.1.0:
- Fixture-first extraction path for public company statement data
- Deterministic XBRL/concept mapping to WACCY accounts
- Deterministic EDGAR pattern extraction for fixture concepts and statement hints
- Period normalization and source provenance
Planned after v0.1.0:
- Live EDGAR filing fetch and full public-company fact ingestion
Extension Packages
Additional data sources are planned as modular extensions, but they are not included in the current repository:
waccy-google- Google Drive and Gmail integrationwaccy-xero- Xero accounting systemwaccy-sage- Sage accounting platformwaccy-stripe- Payment processor datawaccy-salesforce- CRM and sales pipeline data
๐ Project Structure
WACCY uses a monorepo structure where the core platform and first-party extensions are maintained together but built and published separately.
waccy/
โโโ src/
โ โโโ waccy/ # Core platform
โ โโโ core/
โ โ โโโ ontology.py # Standardized chart of accounts
โ โ โโโ models.py # Core data models (Pydantic)
โ โ โโโ validation.py # Data validation (Pandera)
โ โโโ extraction/
โ โ โโโ base.py # Abstract base classes
โ โ โโโ registry.py # Extension registry
โ โ โโโ mapper.py # Mapping to standard ontology
โ โโโ classification/
โ โ โโโ engine.py # LLM-enhanced classification
โ โ โโโ patterns.py # Pattern matching from EDGAR
โ โ โโโ confidence.py # Confidence scoring
โ โโโ modeling/
โ โ โโโ builder.py # Model construction
โ โ โโโ templates.py # Model templates
โ โ โโโ exporters.py # Spreadsheet export
โ โโโ utils/
โ โโโ dates.py
โ โโโ formatting.py
โ โโโ validation.py
โโโ extensions/ # First-party extensions (monorepo)
โ โโโ waccy-quickbooks/ # QuickBooks Online integration
โ โ โโโ src/waccy_quickbooks/
โ โ โโโ pyproject.toml
โ โโโ waccy-edgar/ # SEC EDGAR filing parser
โ โโโ src/waccy_edgar/
โ โโโ pyproject.toml
โโโ tests/
โ โโโ unit/
โ โโโ integration/
โ โโโ fixtures/
โโโ scripts/
โ โโโ publish.py # Publish core package
โ โโโ build-extension.py # Build extension packages
โ โโโ publish-extension.py # Publish extension packages
โโโ docs/
โ โโโ 0-MISSION.md
โ โโโ 1-EXPERIENCE.md
โ โโโ 2-REQUIREMENTS.md
โ โโโ 3-ARCHITECTURE.md
โ โโโ assets/
โ โโโ examples/
โ โโโ references/
โโโ pyproject.toml # Core package configuration
Monorepo Benefits
- Unified Development: All packages in one repository for easier coordination
- Independent Publishing: Each package builds and publishes separately to PyPI
- Shared Standards: Consistent code quality, linting, and testing across packages
- Easier Refactoring: Changes to core can be tested with all extensions immediately
See extensions/README.md for details on working with extensions.
Trusted Publishing
Package publishing uses GitHub Actions and PyPI Trusted Publishers instead of
long-lived PyPI API tokens. The workflow is .github/workflows/publish.yml and
uses the GitHub environment pypi.
Configure each PyPI project with the same trusted publisher:
| PyPI project | Owner | Repository | Workflow | Environment |
|---|---|---|---|---|
waccy |
DecisionNerd |
waccy |
publish.yml |
pypi |
waccy-edgar |
DecisionNerd |
waccy |
publish.yml |
pypi |
waccy-quickbooks |
DecisionNerd |
waccy |
publish.yml |
pypi |
For existing projects, add the publisher from the project's PyPI
Publishing settings. For a new project, add a pending publisher from the
account-level PyPI Publishing page before the first upload. Keep the
GitHub pypi environment limited to main; add required reviewers there when
the repo needs an explicit human approval gate.
๐งช Testing
# Install development dependencies
uv sync --dev
# Run all tests
uv run pytest
# Run with coverage
uv run pytest --cov=waccy --cov-report=html
# Run specific test suites
uv run pytest tests/unit/
uv run pytest tests/integration/
# Format and lint with ruff
uv run ruff format
uv run ruff check --fix
# Type checking with mypy
uv run mypy src/waccy
๐ Documentation
Published docs: https://decisionnerd.github.io/waccy/
- Mission Statement - Project goals, philosophy, and roadmap
- Experience - Target user workflows and release experience
- Requirements - Financial modeling requirements and capabilities
- Architecture - Technical architecture and design principles
- Testing - Quality gates, BDD outcomes, and coverage expectations
๐๏ธ Design Principles
-
Simplicity and Focus: Core platform maintains a simple, focused design with essential data sources (QBO and EDGAR)
-
Standardized Ontology First: All financial data maps to a standardized WACCY chart of accounts, ensuring consistency and comparability
-
Modular Extensibility: New data sources and model types added as separate packages that conform to core interfaces
-
Accuracy First: Deterministic functions preferred over probabilistic models. LLMs used for parsing and classification, not financial calculations
-
Transparency and Auditability: Every data point traceable to source, every calculation explainable, every assumption documented
-
Professional Standards: Models adhere to institutional-quality standards for architecture, formatting, and presentation
-
Quality Quantification: Standardized ontology enables measurement and reporting of data quality and model output reliability
-
Small Business Focus: Designed primarily for small businessesโfrom sole proprietorships to growing companiesโhandling messy, incomplete data
๐ค Contributing
We welcome contributions! WACCY is built for the small business community, and we'd love your help making financial modeling more accessible.
Getting Started
- Fork the repository on GitHub
- Create a feature branch for your contribution
- Set up development environment:
git clone https://github.com/your-username/waccy.git cd waccy uv sync --dev
- Make your changes following our coding standards:
- Use
rufffor formatting and linting - Add type hints with
mypycompliance - Write tests for new functionality
- Update documentation as needed
- Use
- Run tests and linting:
uv run pytest uv run ruff check uv run mypy src/
- Submit a pull request with a clear description of your changes
Creating Extensions
Want to add a new data source? Create an extension package:
- Create a new package:
waccy-yourdatasource - Implement the
Extractorinterface fromwaccy.extraction.base - Register your extension via entry points
- Follow the Extension Development Guide
See our Architecture Documentation for detailed extension development guidelines.
Code of Conduct
Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.
Project Status
- Release candidate core:
waccy 0.1.0 - Release candidate first-party extensions:
waccy-quickbooks 0.1.1,waccy-edgar 0.1.0 - Current implementation: fixture-first v0.1.0 three-statement pipeline with QBO report normalization, EDGAR companyfacts normalization, XLSX export, and pandas handoff
- Current milestone: v0.1.0, with all tracked release-validity issues closed
Planned phases:
- Phase 1: Core foundation and three-statement models
- Phase 2: Public market data and richer pattern learning
- Phase 3: Advanced valuation models
- Phase 4: Specialized model types
- Phase 5: Advanced analysis and decision support
Python Version: 3.13+
Package Manager: uv
CI/CD: GitHub Actions, Codecov, and CodeRabbit
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
๐ Acknowledgments
- Small Business Community - Built for entrepreneurs and small business owners who need professional financial modeling
- Financial Modeling Community - Inspired by institutional-quality modeling standards
- Open Source Tools:
Made with ๐คช for small businesses that deserve institutional-quality financial modeling
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file waccy-0.1.0.tar.gz.
File metadata
- Download URL: waccy-0.1.0.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.13 {"installer":{"name":"uv","version":"0.11.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d1621d203b266921460aab118a83b317d88f693b4eb5bbf70a8edc2ba460432
|
|
| MD5 |
c939ec48105cccb6c95771dbb6acf5dc
|
|
| BLAKE2b-256 |
e34a632fa15580cd45bd50fb3d58276820959acceea8be8bb3f0b036eb1ffac6
|
File details
Details for the file waccy-0.1.0-py3-none-any.whl.
File metadata
- Download URL: waccy-0.1.0-py3-none-any.whl
- Upload date:
- Size: 33.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.13 {"installer":{"name":"uv","version":"0.11.13","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b86da164859672304c20b9d202ed20e617fd4ab988ecd758126e140b256a11eb
|
|
| MD5 |
1f0fe8d17d59bc4fabc7860ce23e8d2f
|
|
| BLAKE2b-256 |
8ace2304a5bbf8d0a3167698354279fa3a5fc3ba6a43e828246727f0f3d0ce7a
|