Skip to content

revenue-kun v0.3.0

Choose a tag to compare

@signal-yield signal-yield released this 13 Jun 00:57

revenue-kun v0.3.0

This release improves CLI UX and diagnostics for CSV and limited text-based PDF ingestion.

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

  • CLI extraction diagnostics summary for CSV and limited text-based PDF inputs
  • Diagnostics output showing:
    • input type
    • recognized canonical fields for PDF inputs
    • extracted unit count
    • failure state
    • existing failure_reason when extraction fails
  • --dry-run mode for validating input extraction and diagnostics without running calculations or generating output artifacts
  • CLI help test to ensure --dry-run remains visible in --help

Changed

  • README updated with v0.3.0 usage examples
  • README now documents:
    • CSV normal execution
    • CSV dry-run
    • text-based PDF normal execution
    • text-based PDF dry-run
    • diagnostics summary
    • safe failure handling
    • extraction_log.json
  • README failure_reason explanation corrected to match the current implementation
  • Package version bumped to 0.3.0

Scope

Supported:

  • CSV input workflow
  • Limited text-based PDF input workflow from v0.2.0
  • CLI diagnostics summary
  • Dry-run validation without calculation or output artifact generation

Not supported / unchanged:

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

Verification

  • #13 / PR #16: extraction diagnostics summary
  • #14 / PR #17: dry-run mode
  • #15 / PR #18: README usage examples and CLI help test
  • CHANGELOG updated for v0.3.0
  • pytest: 107/107 PASSED