ostruct-cli 0.7.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

{ostruct_cli-0.7.0.dist-info → ostruct_cli-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ostruct-cli
-Version: 0.7.0
+Version: 0.7.2
 Summary: CLI for OpenAI Structured Output
 Author: Yaniv Golan
 Author-email: yaniv@golan.name
@@ -14,10 +14,12 @@ Requires-Dist: cachetools (>=5.3.2,<6.0.0)
 Requires-Dist: chardet (>=5.0.0,<6.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: ijson (>=3.2.3,<4.0.0)
+Requires-Dist: jinja2 (>=3.1.2,<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 +27,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 +37,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.dist-info → ostruct_cli-0.7.2.dist-info}/RECORD

@@ -38,8 +38,8 @@ ostruct/cli/token_utils.py,sha256=r4KPEO3Sec18Q6mU0aClK6XGShvusgUggXEQgEPPlaA,13
 ostruct/cli/utils.py,sha256=uY7c0NaINHWfnl77FcPE3TmYUXv3RqEeUTjrCMDij9A,922
 ostruct/cli/validators.py,sha256=k-vmBjkPmC-VwSTM5Yq1zQjGSIOzzTHS4kc0B7Aqpck,3186
 ostruct/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ostruct_cli-0.7.0.dist-info/LICENSE,sha256=QUOY6QCYVxAiH8vdrUTDqe3i9hQ5bcNczppDSVpLTjk,1068
-ostruct_cli-0.7.0.dist-info/METADATA,sha256=1Z54LbqNhr6aRMLvoiTKeaeETc5fNQe31J7Msz4EmyA,8618
-ostruct_cli-0.7.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-ostruct_cli-0.7.0.dist-info/entry_points.txt,sha256=NFq9IuqHVTem0j9zKjV8C1si_zGcP1RL6Wbvt9fUDXw,48
-ostruct_cli-0.7.0.dist-info/RECORD,,
+ostruct_cli-0.7.2.dist-info/LICENSE,sha256=QUOY6QCYVxAiH8vdrUTDqe3i9hQ5bcNczppDSVpLTjk,1068
+ostruct_cli-0.7.2.dist-info/METADATA,sha256=iJHa7gp6eLDvHQMKtuReyMRPmgJESKiNzx-PHMxw9d0,11154
+ostruct_cli-0.7.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ostruct_cli-0.7.2.dist-info/entry_points.txt,sha256=NFq9IuqHVTem0j9zKjV8C1si_zGcP1RL6Wbvt9fUDXw,48
+ostruct_cli-0.7.2.dist-info/RECORD,,