ostruct-cli 0.7.0__tar.gz → 0.7.1__tar.gz

{ostruct_cli-0.7.0 → ostruct_cli-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ostruct-cli
-Version: 0.7.0
+Version: 0.7.1
 Summary: CLI for OpenAI Structured Output
 Author: Yaniv Golan
 Author-email: yaniv@golan.name
@@ -16,8 +16,9 @@ Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: ijson (>=3.2.3,<4.0.0)
 Requires-Dist: jsonschema (>=4.23.0,<5.0.0)
 Requires-Dist: openai (>=1.0.0,<2.0.0)
-Requires-Dist: openai-structured (>=2.1.0,<3.0.0)
+Requires-Dist: openai-structured (>=3.0.0,<4.0.0)
 Requires-Dist: pydantic (>=2.6.3,<3.0.0)
+Requires-Dist: pygments (>=2.15.0,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: tiktoken (==0.9.0)
 Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
@@ -25,7 +26,9 @@ Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
 Requires-Dist: werkzeug (>=3.1.3,<4.0.0)
 Description-Content-Type: text/markdown
 
-# ostruct-cli
+![ostruct](src/assets/ostruct-header.png)
+
+<div align="center">
 
 [![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)
@@ -33,10 +36,66 @@ 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)
 
-ostruct tranforms unstructured inputs into structured, usable JSON output using OpenAI APIs.
+**ostruct** tranforms **unstructured** inputs into **structured**, usable **JSON** output using **OpenAI APIs** using dynamic **templates**
+
+</div>
+
+# ostruct-cli
 
 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.
 
+<div align="center">
+
+![How ostruct works](src/assets/ostrict-hl-diagram.png)
+
+</div>
+
+## Why ostruct?
+
+LLMs are powerful, but getting consistent, structured output from them can be challenging. ostruct solves this problem by providing a streamlined approach to transform unstructured data into reliable JSON structures. The motivation behind creating ostruct was to:
+
+- **Bridge the gap** between freeform LLM capabilities and structured data needs in production systems
+- **Simplify integration** of AI into existing workflows and applications that expect consistent data formats
+- **Ensure reliability** and validate output against a defined schema to avoid unexpected formats or missing data
+- **Reduce development time** by providing a standardized way to interact with OpenAI models for structured outputs
+- **Enable non-developers** to leverage AI capabilities through a simple CLI interface with templates
+
+## Real-World Use Cases
+
+ostruct can be used for various scenarios, including:
+
+### Etymology Analysis
+
+```bash
+ostruct run prompts/task.j2 schemas/etymology.json -f input examples/scientific.txt --model gpt-4o
+```
+
+Break down words into their components, showing their origins, meanings, and hierarchical relationships. Useful for linguistics, educational tools, and understanding terminology in specialized fields.
+
+### Automated Code Review
+
+```bash
+ostruct run prompts/task.j2 schemas/code_review.json -p source "examples/security/*.py" --model gpt-4o
+```
+
+Analyze code for security vulnerabilities, style issues, and performance problems, producing structured reports that can be easily integrated into CI/CD pipelines or developer workflows.
+
+### Security Vulnerability Scanning
+
+```bash
+ostruct run prompts/task.j2 schemas/scan_result.json -d examples/intermediate --model gpt-4o
+```
+
+Scan codebases for security vulnerabilities, combining static analysis with AI-powered reasoning to identify potential issues, suggest fixes, and provide detailed explanations.
+
+### Configuration Validation & Analysis
+
+```bash
+ostruct run prompts/task.j2 schemas/validation_result.json -f dev examples/basic/dev.yaml -f prod examples/basic/prod.yaml
+```
+
+Validate configuration files across environments, check for inconsistencies, and provide intelligent feedback on potential issues or improvements in infrastructure setups.
+
 ## Features
 
 - Generate structured JSON output from natural language using OpenAI models and a JSON schema

{ostruct_cli-0.7.0 → ostruct_cli-0.7.1}/README.md

@@ -1,4 +1,6 @@
-# ostruct-cli
+![ostruct](src/assets/ostruct-header.png)
+
+<div align="center">
 
 [![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)
@@ -6,10 +8,66 @@
 [![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** tranforms **unstructured** inputs into **structured**, usable **JSON** output using **OpenAI APIs** using dynamic **templates**
+
+</div>
+
+# ostruct-cli
 
 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.
 
+<div align="center">
+
+![How ostruct works](src/assets/ostrict-hl-diagram.png)
+
+</div>
+
+## Why ostruct?
+
+LLMs are powerful, but getting consistent, structured output from them can be challenging. ostruct solves this problem by providing a streamlined approach to transform unstructured data into reliable JSON structures. The motivation behind creating ostruct was to:
+
+- **Bridge the gap** between freeform LLM capabilities and structured data needs in production systems
+- **Simplify integration** of AI into existing workflows and applications that expect consistent data formats
+- **Ensure reliability** and validate output against a defined schema to avoid unexpected formats or missing data
+- **Reduce development time** by providing a standardized way to interact with OpenAI models for structured outputs
+- **Enable non-developers** to leverage AI capabilities through a simple CLI interface with templates
+
+## Real-World Use Cases
+
+ostruct can be used for various scenarios, including:
+
+### Etymology Analysis
+
+```bash
+ostruct run prompts/task.j2 schemas/etymology.json -f input examples/scientific.txt --model gpt-4o
+```
+
+Break down words into their components, showing their origins, meanings, and hierarchical relationships. Useful for linguistics, educational tools, and understanding terminology in specialized fields.
+
+### Automated Code Review
+
+```bash
+ostruct run prompts/task.j2 schemas/code_review.json -p source "examples/security/*.py" --model gpt-4o
+```
+
+Analyze code for security vulnerabilities, style issues, and performance problems, producing structured reports that can be easily integrated into CI/CD pipelines or developer workflows.
+
+### Security Vulnerability Scanning
+
+```bash
+ostruct run prompts/task.j2 schemas/scan_result.json -d examples/intermediate --model gpt-4o
+```
+
+Scan codebases for security vulnerabilities, combining static analysis with AI-powered reasoning to identify potential issues, suggest fixes, and provide detailed explanations.
+
+### Configuration Validation & Analysis
+
+```bash
+ostruct run prompts/task.j2 schemas/validation_result.json -f dev examples/basic/dev.yaml -f prod examples/basic/prod.yaml
+```
+
+Validate configuration files across environments, check for inconsistencies, and provide intelligent feedback on potential issues or improvements in infrastructure setups.
+
 ## Features
 
 - Generate structured JSON output from natural language using OpenAI models and a JSON schema

{ostruct_cli-0.7.0 → ostruct_cli-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@
 
     [tool.poetry]
     name = "ostruct-cli"
-    version = "0.7.0"
+    version = "0.7.1"
     description = "CLI for OpenAI Structured Output"
     authors = ["Yaniv Golan <yaniv@golan.name>"]
     readme = "README.md"
@@ -24,8 +24,9 @@
     click = "^8.1.7"
     werkzeug = "^3.1.3"
     openai = "^1.0.0"
-    openai-structured = "^2.1.0"
+    openai-structured = "^3.0.0"
     tiktoken = "0.9.0"
+    pygments = "^2.15.0"
 
     [tool.poetry.scripts]
     ostruct = "ostruct.cli.cli:main"