owlplanner 2025.12.5__py3-none-any.whl → 2026.1.26__py3-none-any.whl

owlplanner/cli/cmd_list.py

@@ -0,0 +1,83 @@
+"""
+CLI command for listing retirement planning case files.
+
+This module provides the 'list' command for discovering and displaying
+information about retirement planning case files in a directory.
+
+Copyright (C) 2025-2026 The Owlplanner Authors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
+
+import click
+from pathlib import Path
+from loguru import logger
+
+import owlplanner as owl
+
+
+@click.command(name="list")
+@click.argument(
+    "directory",
+    type=click.Path(exists=True, file_okay=False, path_type=Path),
+    default=".",
+)
+def cmd_list(directory):
+    """
+    List OWL plan files in a directory.
+
+    DIRECTORY defaults to the current directory.
+    """
+    logger.debug(f"Listing plans in directory: {directory}")
+
+    toml_files = sorted(directory.glob("*.toml"))
+
+    if not toml_files:
+        click.echo("No .toml files found.")
+        return
+
+    plans = []
+
+    for filename in toml_files:
+        try:
+            logger.debug(f"Loading plan from {filename}")
+            plan = owl.readConfig(str(filename), logstreams="loguru", readContributions=False)
+            plans.append((filename.stem, plan))
+        except Exception as e:
+            logger.warning(f"Failed to load {filename}: {e}")
+
+    if not plans:
+        click.echo("No valid OWL plans found.")
+        return
+
+    click.echo(f"{'FILE':<30} {'PLAN NAME':<20} {' TIME LISTS FILE':<30}")
+    click.echo("-" * 80)
+
+    CHECK = "✓"
+    CROSS = "✗"
+
+    plan_dir = directory
+
+    for stem, plan in plans:
+        # Truncate plan name if needed
+        plan_name = plan._name
+        if len(plan_name) > 20:
+            plan_name = plan_name[:16] + "..."
+
+        # Check if timeListsFileName exists in current directory
+        tl_name = plan.timeListsFileName
+        exists = (plan_dir / tl_name).exists() if tl_name else False
+        mark = CHECK if exists else CROSS
+
+        click.echo(f"{stem:<30} {plan_name:<20}  {mark}{tl_name:<30}")

owlplanner/cli/cmd_run.py

@@ -0,0 +1,86 @@
+"""
+CLI command for running retirement planning cases.
+
+This module provides the 'run' command for executing retirement planning
+optimization from the command line.
+
+Copyright (C) 2025-2026 The Owlplanner Authors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""
+
+import click
+from loguru import logger
+import owlplanner as owl
+from pathlib import Path
+
+
+def validate_toml(ctx, param, value: Path):
+    if value is None:
+        return None
+
+    # If no suffix, append .toml
+    if value.suffix == "":
+        value = value.with_suffix(".toml")
+
+    # Enforce .toml extension
+    if value.suffix.lower() != ".toml":
+        raise click.BadParameter("File must have a .toml extension")
+
+    # Check existence AFTER normalization
+    if not value.exists():
+        raise click.BadParameter(f"File '{value}' does not exist")
+
+    if not value.is_file():
+        raise click.BadParameter(f"'{value}' is not a file")
+
+    return value
+
+
+@click.command(name="run")
+@click.argument(
+    "filename",
+    type=click.Path(exists=False, dir_okay=False, path_type=Path),
+    callback=validate_toml,
+)
+@click.option(
+    "--with-config",
+    "with_config",
+    type=click.Choice(["no", "first", "last"], case_sensitive=False),
+    default="first",
+    show_default=True,
+    help="Include config TOML sheet at the first or last position.",
+)
+def cmd_run(filename: Path, with_config: str):
+    """Run the solver for an input OWL plan file.
+
+    FILENAME is the OWL plan file to run. If no extension is provided,
+    .toml will be appended. The file must exist.
+
+    An output Excel file with results will be created in the current directory.
+    The output filename is derived from the input filename by appending
+    '_results.xlsx' to the stem of the input filename.
+
+    Optionally include the case configuration as a TOML worksheet.
+
+    """
+    logger.debug(f"Executing the run command with file: {filename}")
+
+    plan = owl.readConfig(str(filename), logstreams="loguru", readContributions=True)
+    plan.solve(plan.objective, plan.solverOptions)
+    click.echo(f"Case status: {plan.caseStatus}")
+    if plan.caseStatus == "solved":
+        output_filename = filename.with_name(filename.stem + "_results.xlsx")
+        plan.saveWorkbook(basename=output_filename, overwrite=True, with_config=with_config)
+        click.echo(f"Results saved to: {output_filename}")