sysmlv2copilot 0.2.7__tar.gz → 0.2.8__tar.gz

{sysmlv2copilot-0.2.7/sysmlv2copilot.egg-info → sysmlv2copilot-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sysmlv2copilot
-Version: 0.2.7
+Version: 0.2.8
 Summary: Internal Python client SDK and CLI for the SysML refinement API used by the Visual Design and Engineering Lab at Carnegie Mellon University
 Author: Chance LaVoie
 License-Expression: MIT
@@ -103,12 +103,25 @@ repaired = repair(Path("broken.sysml"))
 print(repaired)
 ```
 
+If a `.txt` file contains SysML, `repair()` can use that too:
+
+```python
+from pathlib import Path
+
+from sysmlv2copilot import repair
+
+repaired = repair(Path("broken.txt"))
+print(repaired)
+```
+
 You can pass:
 - raw strings
 - `Path` objects
 - path strings like `"broken.sysml"` or `"requirements.html"`
 - open text files
 
+Use `generate()` for natural-language requirements and `repair()` for SysML, regardless of whether the file extension is `.sysml` or `.txt`.
+
 ## CLI
 
 Generate SysML from inline text:

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/PYPI_README.md

@@ -62,12 +62,25 @@ repaired = repair(Path("broken.sysml"))
 print(repaired)
 ```
 
+If a `.txt` file contains SysML, `repair()` can use that too:
+
+```python
+from pathlib import Path
+
+from sysmlv2copilot import repair
+
+repaired = repair(Path("broken.txt"))
+print(repaired)
+```
+
 You can pass:
 - raw strings
 - `Path` objects
 - path strings like `"broken.sysml"` or `"requirements.html"`
 - open text files
 
+Use `generate()` for natural-language requirements and `repair()` for SysML, regardless of whether the file extension is `.sysml` or `.txt`.
+
 ## CLI
 
 Generate SysML from inline text:

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/README.md

@@ -8,7 +8,7 @@ This repository contains two distinct products:
 
 This repository is API-only. Runtime code currently lives in the root-owned paths such as `app/`, `alembic/`, `sysmlv2copilot/`, `sysmlv2copilot_admin/`, and the main `scripts/` directory.
 
-The hosted service accepts either natural-language requirements or SysML input, runs the compiler-in-the-loop workflow, returns SysML plus structured metadata, and stores each request with a single persisted artifact bundle.
+The hosted service accepts either natural-language requirements or SysML input, runs the compiler-in-the-loop workflow, returns SysML plus structured metadata, and stores each request with a full per-run artifact set including every refinement iteration.
 
 The service itself is intentionally narrow:
 - internal-only
@@ -135,7 +135,7 @@ cp .env.example .env
 ```
 
 3. Fill in at least:
-- one or both of `OPENAI_API_KEY` / `ANTHROPIC_API_KEY`
+- one or both of `OPENAI_API_KEY_5.1` (or shell-safe `OPENAI_API_KEY_5_1`) / `ANTHROPIC_API_KEY`
 - one of `SYSIDE_VENV_PATH` or `SYSIDE_EXECUTABLE_PATH`
 - `API_KEY_HASH_PEPPER`
 - optionally a PostgreSQL `DATABASE_URL`
@@ -212,7 +212,7 @@ Example successful response:
   "request_user_id": "usr_1234",
   "metadata": {
     "provider": "openai",
-    "upstream_model": "gpt-5-mini",
+    "upstream_model": "gpt-5.1-codex",
     "run_id": "run_20260312_161200_abcd",
     "artifact_paths": {
       "request_artifact": "/abs/path/request_artifact.json"
@@ -269,7 +269,7 @@ The hosted API now supports a repair-oriented workflow:
 - run SysIDE immediately
 - if the model already passes, return it unchanged with `iterations_completed = 0`
 - if it fails, feed the broken SysML plus real compiler diagnostics into the repair loop
-- persist the same request tracking and single-artifact bundle used by generation requests
+- persist the full per-run artifact set used by generation requests, including iteration-level files
 
 Repair metadata includes:
 - `metadata.operation = "repair"`
@@ -301,16 +301,18 @@ More detail:
 
 ## Artifact Storage
 
-Artifacts are stored under `ARTIFACT_ROOT`, defaulting to `./data/artifacts`. Each request gets a run directory with a single persisted artifact:
+Artifacts are stored under `ARTIFACT_ROOT`, defaulting to `./data/artifacts`. Each request gets a run directory with:
 - `request_artifact.json`
+- `original_input.txt`
+- `final.sysml`
+- `compiler_output.txt`
+- `run_log.json`
+- `run_meta.json`
+- per-iteration prompt, candidate, raw-response, and compiler-output files under `iterations/`
 
-That JSON bundle stores:
-- the original input text
-- the final SysML output
-- request statistics such as tokens, chars, duration, and iterations
-- provider/model metadata and any terminal error
+The request artifact stores the overall request summary, while `run_log.json` and the iteration files preserve the full loop history for later inspection or dataset creation.
 
-Each request registers exactly one row in the `artifacts` table. Temporary iteration files used during SysIDE checks are removed before persistence.
+Each persisted file registers a row in the `artifacts` table. Temporary scratch files under `_work/` are still removed after the permanent artifacts are written.
 
 ## Tests
 

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sysmlv2copilot"
-version = "0.2.7"
+version = "0.2.8"
 description = "Internal Python client SDK and CLI for the SysML refinement API used by the Visual Design and Engineering Lab at Carnegie Mellon University"
 readme = "PYPI_README.md"
 requires-python = ">=3.11"

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/sysmlv2copilot/__init__.py

@@ -26,7 +26,7 @@ from .types import (
 try:
     __version__ = version("sysmlv2copilot")
 except PackageNotFoundError:
-    __version__ = "0.2.7"
+    __version__ = "0.2.8"
 
 __all__ = [
     "APIConnectionError",

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/sysmlv2copilot/cli.py

@@ -9,7 +9,7 @@ from typing import Any
 from . import __version__
 from .client import DEFAULT_BASE_URL, SysMLCopilot
 from .exceptions import SysMLCopilotError
-from .input_utils import ALLOWED_INPUT_SUFFIXES, coerce_input_text
+from .input_utils import ALLOWED_INPUT_SUFFIXES, coerce_input_text, validate_operation_input
 
 
 def _add_operation_arguments(
@@ -105,8 +105,10 @@ def main(argv: list[str] | None = None) -> int:
     try:
         with SysMLCopilot(api_key=args.api_key, base_url=args.base_url) as client:
             if getattr(args, "operation", None) == "generate":
+                input_text = _read_input_text(args)
+                validate_operation_input(operation="generate", input_text=input_text)
                 response = client.responses.create(
-                    input=_read_input_text(args),
+                    input=input_text,
                     model=args.model,
                     provider=args.provider,
                     upstream_model=args.upstream_model,
@@ -117,8 +119,10 @@ def main(argv: list[str] | None = None) -> int:
                 _print_json(response.model_dump())
                 return 0
             if getattr(args, "operation", None) == "repair":
+                input_text = _read_input_text(args)
+                validate_operation_input(operation="repair", input_text=input_text)
                 response = client.repairs.create(
-                    input=_read_input_text(args),
+                    input=input_text,
                     model=args.model,
                     provider=args.provider,
                     upstream_model=args.upstream_model,

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/sysmlv2copilot/client.py

@@ -24,6 +24,7 @@ from .types import (
 )
 
 DEFAULT_BASE_URL = "https://sysml-refinement-api.lemontree-8a5c4550.eastus.azurecontainerapps.io"
+DEFAULT_TIMEOUT = 600.0
 
 
 def _normalize_base_url(base_url: str) -> str:
@@ -136,7 +137,7 @@ class SysMLCopilot:
         *,
         api_key: str | None = None,
         base_url: str | None = None,
-        timeout: float = 120.0,
+        timeout: float = DEFAULT_TIMEOUT,
         http_client: httpx.Client | None = None,
         default_headers: Mapping[str, str] | None = None,
     ) -> None:
@@ -176,6 +177,12 @@ class SysMLCopilot:
     def _request(self, method: str, path: str, *, json_body: Mapping[str, Any] | None = None) -> Any:
         try:
             response = self._client.request(method, path, json=json_body)
+        except httpx.ReadTimeout as exc:
+            raise APIConnectionError(
+                "Request timed out while waiting for the SysML API response. "
+                "For large inputs, try a longer timeout such as timeout=600. "
+                "Use generate() for natural-language requirements and repair() for SysML input."
+            ) from exc
         except httpx.HTTPError as exc:
             raise APIConnectionError(f"Request failed: {exc}") from exc
         if response.is_error:

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/sysmlv2copilot/convenience.py

@@ -3,8 +3,8 @@ from __future__ import annotations
 from os import PathLike
 from typing import Literal, Protocol, overload
 
-from .client import SysMLCopilot
-from .input_utils import coerce_input_text
+from .client import DEFAULT_TIMEOUT, SysMLCopilot
+from .input_utils import coerce_input_text, validate_operation_input
 from .types import RepairObject, ResponseObject
 
 
@@ -30,7 +30,7 @@ def generate(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: Literal[False] = False,
 ) -> str:
     ...
@@ -48,7 +48,7 @@ def generate(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: Literal[True],
 ) -> ResponseObject:
     ...
@@ -65,10 +65,11 @@ def generate(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: bool = False,
 ) -> str | ResponseObject:
     input_text = coerce_input_text(source)
+    validate_operation_input(operation="generate", input_text=input_text)
     with SysMLCopilot(api_key=api_key, base_url=base_url, timeout=timeout) as client:
         response = client.responses.create(
             input=input_text,
@@ -98,7 +99,7 @@ def repair(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: Literal[False] = False,
 ) -> str:
     ...
@@ -116,7 +117,7 @@ def repair(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: Literal[True],
 ) -> RepairObject:
     ...
@@ -133,10 +134,11 @@ def repair(
     max_iters: int = 10,
     max_total_tokens: int = 40_000,
     temperature: float | None = None,
-    timeout: float = 120.0,
+    timeout: float = DEFAULT_TIMEOUT,
     return_response: bool = False,
 ) -> str | RepairObject:
     input_text = coerce_input_text(source)
+    validate_operation_input(operation="repair", input_text=input_text)
     with SysMLCopilot(api_key=api_key, base_url=base_url, timeout=timeout) as client:
         response = client.repairs.create(
             input=input_text,

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8}/sysmlv2copilot/input_utils.py

@@ -6,6 +6,20 @@ from pathlib import Path
 from typing import Protocol
 
 ALLOWED_INPUT_SUFFIXES = {".txt", ".sysml", ".html", ".htm"}
+_SYSML_MARKERS = (
+    "package ",
+    "part def",
+    "requirement def",
+    "constraint def",
+    "attribute ",
+    "public import",
+    "private import",
+    "port def",
+    "interface def",
+    "state def",
+    "action def",
+    "flow def",
+)
 _BLOCK_HTML_TAGS = {
     "article",
     "aside",
@@ -109,3 +123,30 @@ def _convert_html_to_text(raw_text: str) -> str:
     parser.feed(raw_text)
     parser.close()
     return parser.get_text()
+
+
+def looks_like_sysml(value: str) -> bool:
+    normalized = value.strip().lower()
+    if not normalized:
+        return False
+
+    score = sum(1 for marker in _SYSML_MARKERS if marker in normalized)
+    if "{" in value and "}" in value:
+        score += 1
+    if ";" in value:
+        score += 1
+    return score >= 2
+
+
+def validate_operation_input(*, operation: str, input_text: str) -> None:
+    sysml_like = looks_like_sysml(input_text)
+    if operation == "repair" and not sysml_like:
+        raise ValueError(
+            "repair() expects SysML input. This looks like natural-language requirements. "
+            "Use generate() instead. Function choice is based on file contents, not file extension."
+        )
+    if operation == "generate" and sysml_like:
+        raise ValueError(
+            "generate() expects natural-language requirements. This looks like SysML. "
+            "Use repair() instead. Function choice is based on file contents, not file extension."
+        )

{sysmlv2copilot-0.2.7 → sysmlv2copilot-0.2.8/sysmlv2copilot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sysmlv2copilot
-Version: 0.2.7
+Version: 0.2.8
 Summary: Internal Python client SDK and CLI for the SysML refinement API used by the Visual Design and Engineering Lab at Carnegie Mellon University
 Author: Chance LaVoie
 License-Expression: MIT
@@ -103,12 +103,25 @@ repaired = repair(Path("broken.sysml"))
 print(repaired)
 ```
 
+If a `.txt` file contains SysML, `repair()` can use that too:
+
+```python
+from pathlib import Path
+
+from sysmlv2copilot import repair
+
+repaired = repair(Path("broken.txt"))
+print(repaired)
+```
+
 You can pass:
 - raw strings
 - `Path` objects
 - path strings like `"broken.sysml"` or `"requirements.html"`
 - open text files
 
+Use `generate()` for natural-language requirements and `repair()` for SysML, regardless of whether the file extension is `.sysml` or `.txt`.
+
 ## CLI
 
 Generate SysML from inline text: