ostruct-cli 0.6.1__tar.gz → 0.6.2__tar.gz

{ostruct_cli-0.6.1 → ostruct_cli-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ostruct-cli
-Version: 0.6.1
+Version: 0.6.2
 Summary: CLI for OpenAI Structured Output
 Author: Yaniv Golan
 Author-email: yaniv@golan.name
@@ -33,7 +33,9 @@ Description-Content-Type: text/markdown
 [![CI](https://github.com/yaniv-golan/ostruct/actions/workflows/ci.yml/badge.svg)](https://github.com/yaniv-golan/ostruct/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Command-line interface for working with OpenAI models and structured output, powered by the [openai-structured](https://github.com/yaniv-golan/openai-structured) library.
+ostruct tranforms unstructured inputs into structured, usable JSON output using OpenAI APIs.
+
+ostruct will process a set of plain text files (data, source code, CSV, etc), input variables, a dynamic prompt template, and a JSON schema specifying the desired output format, and will produce the result in JSON format.
 
 ## Features
 
@@ -43,6 +45,10 @@ Command-line interface for working with OpenAI models and structured output, pow
 - Streaming support for real-time output
 - Secure handling of sensitive data
 
+## Requirements
+
+- Python 3.10 or higher
+
 ## Installation
 
 ### For Users
@@ -209,196 +215,52 @@ The command will output:
 }
 ```
 
-### Example 3: Processing Multiple Files
+## System Prompt Handling
 
-1. Create a template file `extract_from_profiles.j2`:
+ostruct-cli provides three ways to specify a system prompt, with a clear precedence order:
 
-```jinja
-Extract information about the people from this data:
+1. Command-line option (`--sys-prompt` or `--sys-file`):
 
-{% for profile in profiles %}
-== {{ profile.name }}
+   ```bash
+   # Direct string
+   ostruct run template.j2 schema.json --sys-prompt "You are an expert analyst"
 
-{{ profile.content }}
+   # From file
+   ostruct run template.j2 schema.json --sys-file system_prompt.txt
+   ```
 
-{% endfor %}
-```
+2. Template frontmatter:
 
-2. Use the same schema file `schema.json` as above, but updated for multiple people:
+   ```jinja
+   ---
+   system_prompt: You are an expert analyst
+   ---
+   Extract information from: {{ text }}
+   ```
 
-```json
-{
-  "type": "object",
-  "properties": {
-    "people": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "The person's full name"
-          },
-          "age": {
-            "type": "integer",
-            "description": "The person's age"
-          },
-          "occupation": {
-            "type": "string",
-            "description": "The person's job or profession"
-          }
-        },
-        "required": ["name", "age", "occupation"],
-        "additionalProperties": false
-      }
-    }
-  },
-  "required": ["people"],
-  "additionalProperties": false
-}
-```
+3. Default system prompt (built into the CLI)
 
-3. Run the CLI:
+### Precedence Rules
 
-```bash
-# Basic usage
-ostruct run extract_from_profiles.j2 schema.json -p profiles "profiles/*.txt"
+When multiple system prompts are provided, they are resolved in this order:
 
-# With advanced options
-ostruct run extract_from_profiles.j2 schema.json \
-  -p profiles "profiles/*.txt" \
-  --model gpt-4o \
-  --sys-prompt "Extract precise information about the person" \
-  --temperature 0.5
-```
+1. Command-line options take highest precedence:
+   - If both `--sys-prompt` and `--sys-file` are provided, `--sys-prompt` wins
+   - Use `--ignore-task-sysprompt` to ignore template frontmatter
 
-The command will output:
+2. Template frontmatter is used if:
+   - No command-line options are provided
+   - `--ignore-task-sysprompt` is not set
 
-```json
-{
-  "people": [
-    {
-      "name": "John Smith",
-      "age": 35,
-      "occupation": "software engineer"
-    },
-    {
-      "name": "Jane Doe",
-      "age": 28,
-      "occupation": "data scientist"
-    }
-  ]
-}
-```
-
-### About Template Files
-
-Template files use the `.j2` extension to indicate they contain Jinja2 template syntax. This convention:
-
-- Enables proper syntax highlighting in most editors
-- Makes it clear the file contains template logic
-- Follows industry standards for Jinja2 templates
+3. Default system prompt is used only if no other prompts are provided
 
-## CLI Options
-
-The CLI revolves around a single subcommand called `run`. Basic usage:
+Example combining multiple sources:
 
 ```bash
-ostruct run <TASK_TEMPLATE> <SCHEMA_FILE> [OPTIONS]
-```
-
-Common options include:
-
-- File & Directory Inputs:
-  - `-f <NAME> <PATH>`: Map a single file to a variable name
-  - `-d <NAME> <DIR>`: Map a directory to a variable name
-  - `-p <NAME> <PATTERN>`: Map files matching a glob pattern to a variable name
-  - `-R, --recursive`: Enable recursive directory/pattern scanning
+# Command-line prompt will override template frontmatter
+ostruct run template.j2 schema.json --sys-prompt "Override prompt"
 
-- Variables:
-  - `-V name=value`: Define a simple string variable
-  - `-J name='{"key":"value"}'`: Define a JSON variable
-
-- Model Parameters:
-  - `-m, --model MODEL`: Select the OpenAI model (supported: gpt-4o, o1, o3-mini)
-  - `--temperature FLOAT`: Set sampling temperature (0.0-2.0)
-  - `--max-output-tokens INT`: Set maximum output tokens
-  - `--top-p FLOAT`: Set top-p sampling parameter (0.0-1.0)
-  - `--frequency-penalty FLOAT`: Adjust frequency penalty (-2.0-2.0)
-  - `--presence-penalty FLOAT`: Adjust presence penalty (-2.0-2.0)
-  - `--reasoning-effort [low|medium|high]`: Control model reasoning effort
-
-- System Prompt:
-  - `--sys-prompt TEXT`: Provide system prompt directly
-  - `--sys-file FILE`: Load system prompt from file
-  - `--ignore-task-sysprompt`: Ignore system prompt in template frontmatter
-
-- API Configuration:
-  - `--api-key KEY`: OpenAI API key (defaults to OPENAI_API_KEY env var)
-  - `--timeout FLOAT`: API timeout in seconds (default: 60.0)
-
-## Debug Options
-
-- `--debug-validation`: Show detailed schema validation debugging
-- `--debug-openai-stream`: Enable low-level debug output for OpenAI streaming
-- `--progress-level {none,basic,detailed}`: Set progress reporting level
-  - `none`: No progress indicators
-  - `basic`: Show key operation steps (default)
-  - `detailed`: Show all steps with additional info
-- `--show-model-schema`: Display the generated Pydantic model schema
-- `--verbose`: Enable verbose logging
-- `--dry-run`: Validate and render template without making API calls
-- `--no-progress`: Disable all progress indicators
-
-All debug and error logs are written to:
-
-- `~/.ostruct/logs/ostruct.log`: General application logs
-- `~/.ostruct/logs/openai_stream.log`: OpenAI streaming operations logs
-
-For more detailed documentation and examples, visit our [documentation](https://ostruct.readthedocs.io/).
-
-## Development
-
-To contribute or report issues, please visit our [GitHub repository](https://github.com/yaniv-golan/ostruct).
-
-## Development Setup
-
-1. Clone the repository:
-
-```bash
-git clone https://github.com/yanivgolan/ostruct.git
-cd ostruct
-```
-
-2. Install Poetry if you haven't already:
-
-```bash
-curl -sSL https://install.python-poetry.org | python3 -
-```
-
-3. Install dependencies:
-
-```bash
-poetry install
-```
-
-4. Install openai-structured in editable mode:
-
-```bash
-poetry add --editable ../openai-structured  # Adjust path as needed
+# Ignore template frontmatter and use default
+ostruct run template.j2 schema.json --ignore-task-sysprompt
 ```
 
-5. Run tests:
-
-```bash
-poetry run pytest
-```
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
-

ostruct_cli-0.6.2/README.md

@@ -0,0 +1,238 @@
+# ostruct-cli
+
+[![PyPI version](https://badge.fury.io/py/ostruct-cli.svg)](https://badge.fury.io/py/ostruct-cli)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ostruct-cli.svg)](https://pypi.org/project/ostruct-cli)
+[![Documentation Status](https://readthedocs.org/projects/ostruct/badge/?version=latest)](https://ostruct.readthedocs.io/en/latest/?badge=latest)
+[![CI](https://github.com/yaniv-golan/ostruct/actions/workflows/ci.yml/badge.svg)](https://github.com/yaniv-golan/ostruct/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+ostruct tranforms unstructured inputs into structured, usable JSON output using OpenAI APIs.
+
+ostruct will process a set of plain text files (data, source code, CSV, etc), input variables, a dynamic prompt template, and a JSON schema specifying the desired output format, and will produce the result in JSON format.
+
+## Features
+
+- Generate structured JSON output from natural language using OpenAI models and a JSON schema
+- Rich template system for defining prompts (Jinja2-based)
+- Automatic token counting and context window management
+- Streaming support for real-time output
+- Secure handling of sensitive data
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+### For Users
+
+To install the latest stable version from PyPI:
+
+```bash
+pip install ostruct-cli
+```
+
+### 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.
+
+## Shell Completion
+
+ostruct-cli supports shell completion for Bash, Zsh, and Fish shells. To enable it:
+
+### Bash
+
+Add this to your `~/.bashrc`:
+
+```bash
+eval "$(_OSTRUCT_COMPLETE=bash_source ostruct)"
+```
+
+### Zsh
+
+Add this to your `~/.zshrc`:
+
+```bash
+eval "$(_OSTRUCT_COMPLETE=zsh_source ostruct)"
+```
+
+### Fish
+
+Add this to your `~/.config/fish/completions/ostruct.fish`:
+
+```fish
+eval (env _OSTRUCT_COMPLETE=fish_source ostruct)
+```
+
+After adding the appropriate line, restart your shell or source the configuration file.
+Shell completion will help you with:
+
+- Command options and their arguments
+- File paths for template and schema files
+- Directory paths for `-d` and `--base-dir` options
+- And more!
+
+## Quick Start
+
+1. Set your OpenAI API key:
+
+```bash
+export OPENAI_API_KEY=your-api-key
+```
+
+### Example 1: Using stdin (Simplest)
+
+1. Create a template file `extract_person.j2`:
+
+```jinja
+Extract information about the person from this text: {{ stdin }}
+```
+
+2. Create a schema file `schema.json`:
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "person": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The person's full name"
+        },
+        "age": {
+          "type": "integer",
+          "description": "The person's age"
+        },
+        "occupation": {
+          "type": "string",
+          "description": "The person's job or profession"
+        }
+      },
+      "required": ["name", "age", "occupation"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["person"],
+  "additionalProperties": false
+}
+```
+
+3. Run the CLI:
+
+```bash
+# Basic usage
+echo "John Smith is a 35-year-old software engineer" | ostruct run extract_person.j2 schema.json
+
+# For longer text using heredoc
+cat << EOF | ostruct run extract_person.j2 schema.json
+John Smith is a 35-year-old software engineer
+working at Tech Corp. He has been programming
+for over 10 years.
+EOF
+
+# With advanced options
+echo "John Smith is a 35-year-old software engineer" | \
+  ostruct run extract_person.j2 schema.json \
+  --model gpt-4o \
+  --sys-prompt "Extract precise information about the person" \
+  --temperature 0.7
+```
+
+The command will output:
+
+```json
+{
+  "person": {
+    "name": "John Smith",
+    "age": 35,
+    "occupation": "software engineer"
+  }
+}
+```
+
+### Example 2: Processing a Single File
+
+1. Create a template file `extract_from_file.j2`:
+
+```jinja
+Extract information about the person from this text: {{ text.content }}
+```
+
+2. Use the same schema file `schema.json` as above.
+
+3. Run the CLI:
+
+```bash
+# Basic usage
+ostruct run extract_from_file.j2 schema.json -f text input.txt
+
+# With advanced options
+ostruct run extract_from_file.j2 schema.json \
+  -f text input.txt \
+  --model gpt-4o \
+  --max-output-tokens 1000 \
+  --temperature 0.7
+```
+
+The command will output:
+
+```json
+{
+  "person": {
+    "name": "John Smith",
+    "age": 35,
+    "occupation": "software engineer"
+  }
+}
+```
+
+## System Prompt Handling
+
+ostruct-cli provides three ways to specify a system prompt, with a clear precedence order:
+
+1. Command-line option (`--sys-prompt` or `--sys-file`):
+
+   ```bash
+   # Direct string
+   ostruct run template.j2 schema.json --sys-prompt "You are an expert analyst"
+
+   # From file
+   ostruct run template.j2 schema.json --sys-file system_prompt.txt
+   ```
+
+2. Template frontmatter:
+
+   ```jinja
+   ---
+   system_prompt: You are an expert analyst
+   ---
+   Extract information from: {{ text }}
+   ```
+
+3. Default system prompt (built into the CLI)
+
+### Precedence Rules
+
+When multiple system prompts are provided, they are resolved in this order:
+
+1. Command-line options take highest precedence:
+   - If both `--sys-prompt` and `--sys-file` are provided, `--sys-prompt` wins
+   - Use `--ignore-task-sysprompt` to ignore template frontmatter
+
+2. Template frontmatter is used if:
+   - No command-line options are provided
+   - `--ignore-task-sysprompt` is not set
+
+3. Default system prompt is used only if no other prompts are provided
+
+Example combining multiple sources:
+
+```bash
+# Command-line prompt will override template frontmatter
+ostruct run template.j2 schema.json --sys-prompt "Override prompt"
+
+# Ignore template frontmatter and use default
+ostruct run template.j2 schema.json --ignore-task-sysprompt
+```

{ostruct_cli-0.6.1 → ostruct_cli-0.6.2}/pyproject.toml

@@ -4,7 +4,7 @@
 
     [tool.poetry]
     name = "ostruct-cli"
-    version = "0.6.1"
+    version = "0.6.2"
     description = "CLI for OpenAI Structured Output"
     authors = ["Yaniv Golan <yaniv@golan.name>"]
     readme = "README.md"