ostruct-cli 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

ostruct_cli-0.4.0.dist-info/METADATA

@@ -1,186 +0,0 @@
-Metadata-Version: 2.3
-Name: ostruct-cli
-Version: 0.4.0
-Summary: CLI for OpenAI Structured Output
-Author: Yaniv Golan
-Author-email: yaniv@golan.name
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-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: jsonschema (>=4.23.0,<5.0.0)
-Requires-Dist: openai (>=1.0.0,<2.0.0)
-Requires-Dist: openai-structured (>=1.3.0,<2.0.0)
-Requires-Dist: pydantic (>=2.6.3,<3.0.0)
-Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
-Requires-Dist: tiktoken (>=0.8.0,<0.9.0)
-Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
-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
-
-[![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)
-
-Command-line interface for working with OpenAI models and structured output, powered by the [openai-structured](https://github.com/yaniv-golan/openai-structured) library.
-
-## Features
-
-- Generate structured output from natural language using OpenAI models
-- Rich template system for defining output schemas
-- Automatic token counting and context window management
-- Streaming support for real-time output
-- Caching system for cost optimization
-- Secure handling of sensitive data
-
-## Installation
-
-```bash
-pip install ostruct-cli
-```
-
-## Quick Start
-
-1. Set your OpenAI API key:
-
-```bash
-export OPENAI_API_KEY=your-api-key
-```
-
-2. Create a task template file `task.j2`:
-
-```
-Extract information about the person: {{ stdin }}
-```
-
-3. Create a schema file `schema.json`:
-
-```json
-{
-  "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"]
-}
-```
-
-4. Run the CLI:
-
-```bash
-echo "John Smith is a 35 year old software engineer" | ostruct --task @task.j2 --schema schema.json
-```
-
-Output:
-
-```json
-{
-  "name": "John Smith",
-  "age": 35,
-  "occupation": "software engineer"
-}
-```
-
-### 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
-
-While the CLI accepts templates with any extension (when prefixed with `@`), we recommend using `.j2` for better tooling support and clarity.
-
-## Debug Options
-
-- `--show-model-schema`: Display the generated Pydantic model schema
-- `--debug-validation`: Show detailed schema validation debugging
-- `--verbose-schema`: Enable verbose schema debugging output
-- `--debug-openai-stream`: Enable low-level debug output for OpenAI streaming (very verbose)
-- `--progress-level {none,basic,detailed}`: Set progress reporting level (default: basic)
-
-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
-```
-
-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.
-
-## Migration from openai-structured
-
-If you were previously using the CLI bundled with openai-structured (pre-1.0.0), this is its new home. The migration is straightforward:
-
-1. Update openai-structured to version 1.0.0 or later
-2. Install ostruct-cli
-3. Replace any `openai-structured` CLI commands with `ostruct`
-
-The functionality remains the same, just moved to a dedicated package for better maintenance and focus.
-

ostruct_cli-0.4.0.dist-info/RECORD

@@ -1,36 +0,0 @@
-ostruct/__init__.py,sha256=X6zo6V7ZNMv731Wi388aTVQngD1410ExGwGx4J6lpyo,187
-ostruct/cli/__init__.py,sha256=sYHKT6o1kFy1acbXejzAvVm8Cy8U91Yf1l4DlzquHKg,409
-ostruct/cli/cache_manager.py,sha256=ej3KrRfkKKZ_lEp2JswjbJ5bW2ncsvna9NeJu81cqqs,5192
-ostruct/cli/cli.py,sha256=kh2_P8O7BAbu7qWB64d1qH0rgWSJZuyxn4MdXd13h4I,65574
-ostruct/cli/click_options.py,sha256=rrx04tiZmOu2103k0WJMNtc4ZYGpDftD9DjtGCVaNW0,7551
-ostruct/cli/errors.py,sha256=lr8c4nkRCZZ5QoWHMZxX4B22CNoaoL1JJx8Y8WTt53Y,10448
-ostruct/cli/file_info.py,sha256=xafeONqhUC7D9OPVuDIlc-44KcrPjdEBVmHN69CEtzs,13838
-ostruct/cli/file_list.py,sha256=OiOl0NfkrWipZEdtRAf4eDJGDo2kyWdurxmU2k4KaZ0,11438
-ostruct/cli/file_utils.py,sha256=On5zjqTx0qKlcZBbt1SNaq7HXtEON5_vyeTFE4UsCFg,22075
-ostruct/cli/path_utils.py,sha256=RzGO-QOrp__NtDcIfAjfKl71NSXz3m_pb07UybgF8ro,3681
-ostruct/cli/progress.py,sha256=rj9nVEco5UeZORMbzd7mFJpFGJjbH9KbBFh5oTE5Anw,3415
-ostruct/cli/security/__init__.py,sha256=CQpkCgTFYlA1p6atpQeNgIKtE4LZGUKt4EbytbGKpCs,846
-ostruct/cli/security/allowed_checker.py,sha256=y_R1UIJeGr1Ah1jlsg8t6aO28DnOfLqSH0wqmlVhx5A,1369
-ostruct/cli/security/case_manager.py,sha256=I_ZJSyntLuGx5qVzze559CI-OxsaNPSibkAN8zZ7PvE,2345
-ostruct/cli/security/errors.py,sha256=hDYKxo7V600ibXtXbrDoCbLNL7MEkarZEQbO2QYfTnI,5859
-ostruct/cli/security/normalization.py,sha256=qevvxW3hHDtD1cVvDym8LJEQD1AKenVB-0ZvjCYjn5E,5242
-ostruct/cli/security/safe_joiner.py,sha256=PHowCeBAkfHfPqRwuO5Com0OemGuq3cHkdu2p9IYNT0,7107
-ostruct/cli/security/security_manager.py,sha256=KkI-fApKoDfRD7HSlz_H5LrIMbM5Rz9aP727t4Q_b5g,12770
-ostruct/cli/security/symlink_resolver.py,sha256=wtZdJ_T_0FOy6B1P5ty1odEXQk9vr8BzlWeAFD4huJE,16744
-ostruct/cli/security/types.py,sha256=15yuG_T4CXyAFFFdSWLjVS7ACmDGIPXhQpZ8awcDwCQ,2991
-ostruct/cli/security/windows_paths.py,sha256=qxC2H2kLwtmQ7YePYde3UrmOJcGnsLEebDLh242sUaI,13453
-ostruct/cli/template_env.py,sha256=S2ZvxuMQMicodSVqUhrw0kOzbNmlpQjSHtWlOwjXCms,1538
-ostruct/cli/template_extensions.py,sha256=tJN3HGAS2yzGI8Up6STPday8NVL0VV6UCClBrtDKYr0,1623
-ostruct/cli/template_filters.py,sha256=wZiR08e2_2SW28B7_tTU3wiij_KTCx3CCvlg-P2q7mk,19126
-ostruct/cli/template_io.py,sha256=yUWO-8rZnSdX97DTMSEX8fG9CP1ISsOhm2NZN3Fab9A,8821
-ostruct/cli/template_rendering.py,sha256=GrQAcKpGe6QEjSVQkOjpegMcor9LzVUikGmmEVgiWCE,12391
-ostruct/cli/template_schema.py,sha256=ckH4rUZnEgfm_BHS9LnMGr8LtDxRmZ0C6UBVrSp8KTc,19604
-ostruct/cli/template_utils.py,sha256=QGgewxU_Tgn81J5U-Y4xfi67CkN2dEqXI7PsaNiI9es,7812
-ostruct/cli/template_validation.py,sha256=q3ACw4TscdekJb3Z3CTYw0YPEYttqjKjm74ap4lWtU4,11737
-ostruct/cli/utils.py,sha256=1UCl4rHjBWKR5EKugvlVGHiHjO3XXmqvkgeAUSyIPDU,831
-ostruct/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ostruct_cli-0.4.0.dist-info/LICENSE,sha256=QUOY6QCYVxAiH8vdrUTDqe3i9hQ5bcNczppDSVpLTjk,1068
-ostruct_cli-0.4.0.dist-info/METADATA,sha256=Khg3pmpYFixNMW_RrpF9bfD_ZRJDjAqP4VDWDdMcBhY,5405
-ostruct_cli-0.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-ostruct_cli-0.4.0.dist-info/entry_points.txt,sha256=NFq9IuqHVTem0j9zKjV8C1si_zGcP1RL6Wbvt9fUDXw,48
-ostruct_cli-0.4.0.dist-info/RECORD,,