refi-calculator 0.7.0__py3-none-any.whl

refi_calculator/__init__.py

@@ -0,0 +1,37 @@
+"""Refinance calculator package exports."""
+
+from __future__ import annotations
+
+from .core import (
+    LoanParams,
+    RefinanceAnalysis,
+    analyze_refinance,
+    calculate_accelerated_payoff,
+    calculate_total_cost_npv,
+    generate_amortization_schedule,
+    generate_amortization_schedule_pair,
+    generate_comparison_schedule,
+    run_holding_period_analysis,
+    run_sensitivity,
+)
+from .gui import RefinanceCalculatorApp, SavingsChart, main
+
+__all__ = [
+    "analyze_refinance",
+    "calculate_accelerated_payoff",
+    "calculate_total_cost_npv",
+    "generate_amortization_schedule_pair",
+    "generate_amortization_schedule",
+    "generate_comparison_schedule",
+    "run_holding_period_analysis",
+    "run_sensitivity",
+    "LoanParams",
+    "RefinanceAnalysis",
+    "RefinanceCalculatorApp",
+    "SavingsChart",
+    "main",
+]
+
+__description__ = """
+Root package for the refinance calculator application.
+"""

refi_calculator/cli.py

@@ -0,0 +1,64 @@
+"""Command-line launcher for the refinance calculator app."""
+
+from __future__ import annotations
+
+import argparse
+import os
+from importlib.metadata import PackageNotFoundError, version
+from logging import basicConfig, getLogger
+
+from refi_calculator.environment import load_dotenv
+from refi_calculator.gui.app import main as launch_gui
+
+logger = getLogger(__name__)
+
+
+def _get_distribution_version() -> str | None:
+    if env_version := os.environ.get("REFI_VERSION"):
+        return env_version
+    try:
+        return version("refi-calculator")
+    except PackageNotFoundError:
+        logger.debug("Unable to determine installed version.")
+        return None
+
+
+def _create_parser() -> argparse.ArgumentParser:
+    """Build the CLI argument parser.
+
+    Returns:
+        A configured parser for handling CLI options.
+    """
+    parser = argparse.ArgumentParser(
+        prog="refi-calculator",
+        description="Launch the refinance calculator UI.",
+    )
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="version",
+        version=_get_distribution_version() or "refi-calculator (development build)",
+        help="Show version information and exit.",
+    )
+    return parser
+
+
+def main(argv: list[str] | None = None) -> None:
+    """Launch the refinance calculator UI.
+
+    Args:
+        argv: Optional argument list; defaults to ``sys.argv`` when ``None``.
+    """
+    parser = _create_parser()
+    parser.parse_args(argv)
+    load_dotenv()
+    basicConfig(level="INFO")
+    logger.info("Launching Refi-Calculator UI")
+    launch_gui()
+
+
+__all__ = ["main"]
+
+__description__ = """
+Command-line launcher for the refinance calculator UI.
+"""

refi_calculator/core/__init__.py

@@ -0,0 +1,36 @@
+"""Shared core library for the refinance calculator package."""
+
+from __future__ import annotations
+
+from .calculations import (
+    analyze_refinance,
+    calculate_accelerated_payoff,
+    calculate_total_cost_npv,
+    generate_amortization_schedule,
+    generate_amortization_schedule_pair,
+    generate_comparison_schedule,
+    run_holding_period_analysis,
+    run_sensitivity,
+)
+from .charts import MIN_LINEAR_TICKS, build_linear_ticks, build_month_ticks
+from .models import LoanParams, RefinanceAnalysis
+
+__all__: list[str] = [
+    "analyze_refinance",
+    "calculate_accelerated_payoff",
+    "calculate_total_cost_npv",
+    "generate_amortization_schedule",
+    "generate_amortization_schedule_pair",
+    "generate_comparison_schedule",
+    "run_holding_period_analysis",
+    "run_sensitivity",
+    "LoanParams",
+    "RefinanceAnalysis",
+    "MIN_LINEAR_TICKS",
+    "build_month_ticks",
+    "build_linear_ticks",
+]
+
+__description__ = """
+Common calculations, models, and chart helpers that can be shared across interfaces.
+"""