ostruct-cli 0.8.3__tar.gz → 0.8.7__tar.gz

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ostruct-cli
-Version: 0.8.3
+Version: 0.8.7
 Summary: CLI for OpenAI Structured Output with Multi-Tool Integration
 Author: Yaniv Golan
 Author-email: yaniv@golan.name
@@ -39,6 +39,7 @@ Requires-Dist: pytest (>=8.3.4,<9.0) ; extra == "dev"
 Requires-Dist: pytest-asyncio (>=0.25.2,<1.0) ; extra == "dev"
 Requires-Dist: pytest-mock (>=3.14.0,<4.0) ; extra == "dev"
 Requires-Dist: pytest-rerunfailures (>=12.0,<13.0) ; extra == "dev"
+Requires-Dist: python-dotenv (>=1.0.1,<2.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0) ; extra == "dev"
 Requires-Dist: pyyaml (>=6.0.2,<7.0)
 Requires-Dist: sphinx (>=7.0,<8.0) ; extra == "dev"
@@ -48,6 +49,7 @@ Requires-Dist: sphinx-rtd-theme (>=1.0,<2.0) ; extra == "docs"
 Requires-Dist: tenacity (>=8.2.3,<9.0) ; extra == "examples"
 Requires-Dist: tiktoken (==0.9.0)
 Requires-Dist: tomli (>=2.0.1,<3.0) ; (python_version < "3.11") and (extra == "docs")
+Requires-Dist: tomli (>=2.0.1,<3.0) ; extra == "dev"
 Requires-Dist: tomli (>=2.0.1,<3.0) ; python_version < "3.11"
 Requires-Dist: twine (>=6.0.1,<7.0) ; extra == "dev"
 Requires-Dist: types-cachetools (>=5.5.0.20240820) ; extra == "dev"
@@ -214,7 +216,27 @@ Break down words into their components, showing their origins, meanings, and hie
 
 ## Installation
 
-### For Users
+### Quick Install (macOS)
+
+For macOS users, we provide a one-line installer that handles everything automatically:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/yaniv-golan/ostruct/main/scripts/install-macos.sh | bash
+```
+
+This script will:
+
+- Install Python 3.10+ if needed (via Homebrew or python.org)
+- Install Homebrew if needed
+- Install ostruct-cli via pip
+- Configure your shell PATH automatically
+- Verify the installation works
+
+After installation, restart your terminal and test with `ostruct --version`.
+
+### Manual Installation
+
+#### For Users
 
 To install the latest stable version from PyPI:
 
@@ -222,7 +244,9 @@ To install the latest stable version from PyPI:
 pip install ostruct-cli
 ```
 
-### For Developers
+**Note**: If the `ostruct` command isn't found after installation, you may need to add Python's user bin directory to your PATH. See the [troubleshooting guide](scripts/README.md#troubleshooting) for details.
+
+#### For Developers
 
 If you plan to contribute to the project, see the [Development Setup](#development-setup) section below for instructions on setting up the development environment with Poetry.
 
@@ -237,6 +261,8 @@ ostruct-cli respects the following environment variables:
 - `OSTRUCT_DISABLE_REGISTRY_UPDATE_CHECKS`: Set to "1", "true", or "yes" to disable automatic registry update checks
 - `MCP_<NAME>_URL`: Custom MCP server URLs (e.g., `MCP_STRIPE_URL=https://mcp.stripe.com`)
 
+**💡 Tip**: ostruct automatically loads `.env` files from the current directory. Environment variables take precedence over `.env` file values.
+
 <details>
 <summary><strong>Shell Completion Setup</strong> (Click to expand)</summary>
 
@@ -427,7 +453,11 @@ tools:
 1. Set your OpenAI API key:
 
 ```bash
+# Environment variable
 export OPENAI_API_KEY=your-api-key
+
+# Or create a .env file
+echo 'OPENAI_API_KEY=your-api-key' > .env
 ```
 
 ### Example 1: Basic Text Extraction (Simplest)

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/README.md

@@ -151,7 +151,27 @@ Break down words into their components, showing their origins, meanings, and hie
 
 ## Installation
 
-### For Users
+### Quick Install (macOS)
+
+For macOS users, we provide a one-line installer that handles everything automatically:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/yaniv-golan/ostruct/main/scripts/install-macos.sh | bash
+```
+
+This script will:
+
+- Install Python 3.10+ if needed (via Homebrew or python.org)
+- Install Homebrew if needed
+- Install ostruct-cli via pip
+- Configure your shell PATH automatically
+- Verify the installation works
+
+After installation, restart your terminal and test with `ostruct --version`.
+
+### Manual Installation
+
+#### For Users
 
 To install the latest stable version from PyPI:
 
@@ -159,7 +179,9 @@ To install the latest stable version from PyPI:
 pip install ostruct-cli
 ```
 
-### For Developers
+**Note**: If the `ostruct` command isn't found after installation, you may need to add Python's user bin directory to your PATH. See the [troubleshooting guide](scripts/README.md#troubleshooting) for details.
+
+#### For Developers
 
 If you plan to contribute to the project, see the [Development Setup](#development-setup) section below for instructions on setting up the development environment with Poetry.
 
@@ -174,6 +196,8 @@ ostruct-cli respects the following environment variables:
 - `OSTRUCT_DISABLE_REGISTRY_UPDATE_CHECKS`: Set to "1", "true", or "yes" to disable automatic registry update checks
 - `MCP_<NAME>_URL`: Custom MCP server URLs (e.g., `MCP_STRIPE_URL=https://mcp.stripe.com`)
 
+**💡 Tip**: ostruct automatically loads `.env` files from the current directory. Environment variables take precedence over `.env` file values.
+
 <details>
 <summary><strong>Shell Completion Setup</strong> (Click to expand)</summary>
 
@@ -364,7 +388,11 @@ tools:
 1. Set your OpenAI API key:
 
 ```bash
+# Environment variable
 export OPENAI_API_KEY=your-api-key
+
+# Or create a .env file
+echo 'OPENAI_API_KEY=your-api-key' > .env
 ```
 
 ### Example 1: Basic Text Extraction (Simplest)

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "ostruct-cli"
-version = "0.8.3"
+version = "0.8.7"
 description = "CLI for OpenAI Structured Output with Multi-Tool Integration"
 authors = [{name = "Yaniv Golan", email = "yaniv@golan.name"}]
 readme = "README.md"
@@ -25,6 +25,7 @@ dependencies = [
     "pygments>=2.15.0,<3.0",
     "jinja2>=3.1.2,<4.0",
     "openai-model-registry>=0.7.0,<1.0",
+    "python-dotenv>=1.0.1,<2.0",
 ]
 
 [project.scripts]
@@ -56,6 +57,7 @@ dev = [
     "pre-commit>=4.1.0,<5.0",
     "psutil>=7.0.0,<8.0",
     "hypothesis>=6.0.0,<7.0",
+    "tomli>=2.0.1,<3.0",
 ]
 docs = [
     "sphinx>=7.0,<8.0",

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/src/ostruct/cli/cli.py

@@ -4,6 +4,7 @@ import sys
 from typing import Optional
 
 import click
+from dotenv import load_dotenv
 
 from .. import __version__
 from .commands import create_command_group
@@ -107,6 +108,9 @@ def create_cli() -> click.Command:
 
 def main() -> None:
     """Main entry point for the CLI."""
+    # Load environment variables from .env file
+    load_dotenv()
+
     try:
         cli(standalone_mode=False)
     except (

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/src/ostruct/cli/click_options.py

@@ -492,12 +492,13 @@ def api_options(f: Union[Command, Callable[..., Any]]) -> Command:
         environment variable.""",
     )(cmd)
 
+    # API timeout for OpenAI calls
     cmd = click.option(
         "--timeout",
         type=click.FloatRange(1.0, None),
         default=60.0,
         show_default=True,
-        help="API timeout in seconds.",
+        help="Timeout in seconds for OpenAI API calls.",
     )(cmd)
 
     return cast(Command, cmd)
@@ -854,13 +855,6 @@ def debug_progress_options(f: Union[Command, Callable[..., Any]]) -> Command:
         "--verbose", is_flag=True, help="Enable verbose logging"
     )(cmd)
 
-    cmd = click.option(
-        "--timeout",
-        type=int,
-        default=3600,
-        help="Operation timeout in seconds (default: 3600 = 1 hour)",
-    )(cmd)
-
     return cast(Command, cmd)
 
 

{ostruct_cli-0.8.3 → ostruct_cli-0.8.7}/src/ostruct/cli/runner.py

@@ -33,9 +33,6 @@ from .sentinel import extract_json_block
 from .serialization import LogSerializer
 from .services import ServiceContainer
 from .types import CLIParams
-from .unattended_operation import (
-    UnattendedOperationManager,
-)
 
 
 # Error classes for API operations
@@ -855,10 +852,6 @@ async def execute_model(
     """Execute the model with the given parameters."""
     logger.debug("=== Execution Phase ===")
 
-    # Initialize unattended operation manager
-    timeout_seconds = int(args.get("timeout", 3600))
-    operation_manager = UnattendedOperationManager(timeout_seconds)
-
     # Pre-validate unattended compatibility
     # Note: MCP validation is handled during MCP configuration processing
     # mcp_servers = args.get("mcp_servers", [])
@@ -874,12 +867,22 @@ async def execute_model(
 
     api_key = args.get("api_key") or os.getenv("OPENAI_API_KEY")
     if not api_key:
-        msg = "No API key provided. Set OPENAI_API_KEY environment variable or use --api-key"
+        msg = (
+            "No OpenAI API key found. Please:\n"
+            "  • Set OPENAI_API_KEY environment variable, or\n"
+            "  • Create a .env file with OPENAI_API_KEY=your-key-here, or\n"
+            "  • Use --api-key option (not recommended for production)\n"
+            "\n"
+            "Get your API key from: https://platform.openai.com/api-keys"
+        )
         logger.error(msg)
         raise CLIError(msg, exit_code=ExitCode.API_ERROR)
 
+    # Get API timeout
+    api_timeout = args.get("timeout", 60.0)
     client = AsyncOpenAI(
-        api_key=api_key, timeout=min(args.get("timeout", 60.0), 300.0)
+        api_key=api_key,
+        timeout=min(float(api_timeout), 300.0),
     )  # Cap at 5 min for client timeout
 
     # Create service container for dependency management
@@ -1352,13 +1355,10 @@ async def execute_model(
 
         return ExitCode.SUCCESS
 
-    # Execute main operation with timeout safeguards
+    # Execute main operation
     try:
-        result = await operation_manager.execute_with_safeguards(
-            execute_main_operation, "model execution"
-        )
-        # The result should be an ExitCode from execute_main_operation
-        return result  # type: ignore[no-any-return]
+        result = await execute_main_operation()
+        return result
     except (
         APIResponseError,
         EmptyResponseError,