Skip to content

revenue-kun v0.2.0

Choose a tag to compare

@signal-yield signal-yield released this 12 Jun 09:01

revenue-kun v0.2.0

This release adds limited text-based PDF ingestion support for simple rent roll tables.

revenue-kun remains a direct-capitalization-based income estimate CLI. It does not provide formal real estate valuation, investment advice, or legal advice. Outputs should be treated as supporting estimates for practitioner review, not as a substitute for professional judgment.

Added

  • Text-based PDF ingestion for simple rent roll tables
  • Column alias mapping for rent roll PDF fields
  • Safe failure handling for unreliable PDF extraction
  • Machine-readable failure_reason in extraction logs
  • V020_PDF_INGESTION_ACCEPTANCE_REPORT.md acceptance report

Changed

  • PDF extraction now excludes sub-header rows and repeated-header-like rows
  • Sample C extraction behavior improved: extracted_units_count 8 → 6
  • README updated to clarify v0.2.0 PDF ingestion scope and limitations
  • CHANGELOG updated with v0.2.0 notes

Fixed

  • Unsafe PDF extraction no longer fails silently in known unreliable cases
  • Safe failure conditions added for:
    • no table detected on all pages
    • header detected but no data rows
    • occupied units exist but all monthly rents are non-numeric

Scope

Supported:

  • Text-based PDFs
  • Simple rent roll tables
  • Basic column alias mapping
  • Sub-header / repeated-header row exclusion
  • Safe failure logging

Not supported:

  • OCR
  • Scanned PDFs
  • Multi-page table stitching
  • Complex merged cells
  • Vendor-specific heuristics
  • PII masking
  • Formal valuation, investment advice, or legal advice

Verification

  • PR #9 / Issue #6: sub-header and repeated-header row exclusion
  • PR #10 / Issue #7: column alias mapping
  • PR #11 / Issue #8: safe failure handling
  • pytest:
    • PR #9: 42/42 PASSED
    • PR #10: 80/80 PASSED
    • PR #11: 84/84 PASSED
  • Acceptance report: V020_PDF_INGESTION_ACCEPTANCE_REPORT.md