generated from coulomb/repo-seed
Update payment_records to 8.99 EUR gross, 0.44 EUR fees, 8.55 EUR net payout to binky-hedgehog. Link member tegwick in membership ledger and add Stripe reference catalog.
170 lines
6.5 KiB
Python
170 lines
6.5 KiB
Python
from __future__ import annotations
|
||
|
||
import argparse
|
||
from decimal import Decimal
|
||
from pathlib import Path
|
||
|
||
from .economics import build_liquidity_summary, build_snapshot
|
||
from .load import (
|
||
default_data_dir,
|
||
latest_period,
|
||
load_budget,
|
||
load_expense_records,
|
||
load_membership,
|
||
load_monthly_ledger,
|
||
load_payment_records,
|
||
load_pricing_models,
|
||
load_product,
|
||
)
|
||
from .models import EconomicsSnapshot, LiquiditySummary, MonthlyPlatformCost, PaymentRecord, PricingModel, Product
|
||
|
||
|
||
def _history_rows(
|
||
monthly_costs: list[MonthlyPlatformCost],
|
||
payments: list[PaymentRecord],
|
||
through_period: str,
|
||
) -> str:
|
||
payment_by_period = {record.period: record for record in payments}
|
||
lines: list[str] = []
|
||
for month in sorted(monthly_costs, key=lambda item: item.period):
|
||
if month.period > through_period:
|
||
continue
|
||
payment = payment_by_period.get(month.period)
|
||
net_payment = payment.net_amount if payment else Decimal("0")
|
||
period_net = net_payment - month.infrastructure_cost
|
||
lines.append(
|
||
f"| {month.period} | {month.active_members} | {month.gross_revenue} | "
|
||
f"{month.infrastructure_cost} | {month.payment_processing_cost} | "
|
||
f"{month.total_platform_cost} | {period_net:.2f} |"
|
||
)
|
||
return "\n".join(lines)
|
||
|
||
|
||
def render_dashboard(
|
||
product: Product,
|
||
models: list[PricingModel],
|
||
snapshot: EconomicsSnapshot,
|
||
liquidity: LiquiditySummary,
|
||
monthly_costs: list[MonthlyPlatformCost],
|
||
payments: list[PaymentRecord],
|
||
expense_count: int,
|
||
) -> str:
|
||
active = next(m for m in models if m.id == product.active_pricing_model_id)
|
||
registry_lines = "\n".join(
|
||
f"| {model.id} | {model.name} | {model.model_type} | {model.status} |"
|
||
for model in models
|
||
)
|
||
history_lines = _history_rows(monthly_costs, payments, snapshot.period)
|
||
budget_state = (
|
||
"over budget"
|
||
if liquidity.remaining_budget < Decimal("0")
|
||
else "within budget"
|
||
)
|
||
|
||
return f"""# Economics Dashboard v1 — {product.name}
|
||
|
||
**Period:** {snapshot.period}
|
||
**Lifecycle phase:** {product.lifecycle_phase}
|
||
**Active pricing model:** {active.name} ({active.access_fee_amount} {active.currency}/{active.access_fee_cadence})
|
||
|
||
> Platform costs accrue to the operator. Customer cost-pass-through billing is
|
||
> **not active** in MVP — members pay subscription only. All totals are computed
|
||
> programmatically from expense and payment record ledgers ({expense_count} expense
|
||
> records).
|
||
|
||
## Key Metrics (current period)
|
||
|
||
| Metric | Value |
|
||
|--------|------:|
|
||
| Active members | {snapshot.active_members} |
|
||
| Member payments (gross) | {snapshot.monthly_revenue} {snapshot.currency} |
|
||
| Infrastructure cost | {snapshot.monthly_infrastructure_cost} {snapshot.currency} |
|
||
| Payment processing cost | {snapshot.monthly_payment_processing_cost} {snapshot.currency} |
|
||
| Total platform cost | {snapshot.monthly_total_platform_cost} {snapshot.currency} |
|
||
| Platform cost per member | {snapshot.cost_per_member} {snapshot.currency} |
|
||
| Period gross margin | {snapshot.gross_margin} {snapshot.currency} |
|
||
| Period gross margin % | {snapshot.gross_margin_pct}% |
|
||
| Period net liquidity | {snapshot.period_net_liquidity} {snapshot.currency} ({snapshot.liquidity_status}) |
|
||
|
||
_Period net liquidity = net member payments − infrastructure cost (processing fees already netted from payments)._
|
||
_Revenue source: {snapshot.revenue_source}_
|
||
|
||
## Liquidity & Budget (through {liquidity.through_period})
|
||
|
||
| Metric | Value |
|
||
|--------|------:|
|
||
| Initial budget | {liquidity.initial_budget} {liquidity.currency} |
|
||
| Cumulative member payments (net) | {liquidity.cumulative_member_payments} {liquidity.currency} |
|
||
| Cumulative infrastructure cost | {liquidity.cumulative_infrastructure_cost} {liquidity.currency} |
|
||
| Cumulative payment processing | {liquidity.cumulative_payment_processing_cost} {liquidity.currency} |
|
||
| Cumulative total platform cost | {liquidity.cumulative_total_platform_cost} {liquidity.currency} |
|
||
| Cumulative net liquidity | {liquidity.cumulative_net_liquidity} {liquidity.currency} ({liquidity.liquidity_status}) |
|
||
| Remaining budget | {liquidity.remaining_budget} {liquidity.currency} ({budget_state}) |
|
||
| Months tracked | {liquidity.months_tracked} |
|
||
|
||
## Monthly History
|
||
|
||
| Period | Members | Gross revenue | Infrastructure | Processing | Total platform | Net liquidity |
|
||
|--------|--------:|--------------:|---------------:|-----------:|---------------:|--------------:|
|
||
{history_lines}
|
||
|
||
## Pricing Model Registry
|
||
|
||
| ID | Name | Type | Status |
|
||
|----|------|------|--------|
|
||
{registry_lines}
|
||
|
||
## Registries Loaded
|
||
|
||
- Product model (`data/product.json`)
|
||
- Budget (`data/budget.json`)
|
||
- Expense records (`data/expense_records.json`) — source of truth for costs
|
||
- Infrastructure catalog (`data/infrastructure/`) — domain, VPS, and Stripe reference data
|
||
- Payment records (`data/payment_records.json`)
|
||
- Membership (`data/membership.json`)
|
||
- Requirements (`REQUIREMENTS.md`)
|
||
"""
|
||
|
||
|
||
def generate_dashboard(data_dir: Path | None = None, period: str | None = None) -> str:
|
||
root = data_dir or default_data_dir()
|
||
product = load_product(root)
|
||
budget = load_budget(root)
|
||
models = load_pricing_models(root)
|
||
members = load_membership(root)
|
||
payments = load_payment_records(root)
|
||
expenses = load_expense_records(root)
|
||
monthly_costs = load_monthly_ledger(root)
|
||
target_period = period or latest_period(monthly_costs)
|
||
|
||
snapshot = build_snapshot(target_period, product, models, members, payments, monthly_costs)
|
||
liquidity = build_liquidity_summary(budget, payments, monthly_costs, target_period)
|
||
return render_dashboard(
|
||
product, models, snapshot, liquidity, monthly_costs, payments, len(expenses)
|
||
)
|
||
|
||
|
||
def main(argv: list[str] | None = None) -> int:
|
||
parser = argparse.ArgumentParser(description="Coulomb Social Economics Dashboard v1")
|
||
parser.add_argument("--data-dir", type=Path, default=None, help="Registry data directory")
|
||
parser.add_argument("--period", default=None, help="Reporting period (YYYY-MM)")
|
||
parser.add_argument(
|
||
"--output",
|
||
type=Path,
|
||
default=None,
|
||
help="Write Markdown report to this path (default: stdout only)",
|
||
)
|
||
args = parser.parse_args(argv)
|
||
|
||
report = generate_dashboard(args.data_dir, args.period)
|
||
if args.output:
|
||
args.output.parent.mkdir(parents=True, exist_ok=True)
|
||
args.output.write_text(report, encoding="utf-8")
|
||
print(f"Wrote {args.output}")
|
||
else:
|
||
print(report)
|
||
return 0
|
||
|
||
|
||
if __name__ == "__main__":
|
||
raise SystemExit(main()) |