Skip to main content

Internal Python client SDK and CLI for the SysML refinement API used by the Visual Design and Engineering Lab at Carnegie Mellon University

Project description

sysmlv2copilot

sysmlv2copilot is the Python SDK and CLI for the SysML Copilot service used by the Visual Design and Engineering Lab at Carnegie Mellon University.

This package is for authorized internal users. Installing it does not by itself grant service access.

What Users Can Do

  • Generate SysML from text requirements
  • Repair existing SysML
  • Use either Python or the command line

Install

python -m pip install sysmlv2copilot

Authentication

Set your API key once:

export SYSMLV2COPILOT_API_KEY=sysml_live_...

Or pass it directly in code.

Python

Generate SysML:

from sysmlv2copilot import SysMLCopilot

with SysMLCopilot() as client:
    response = client.responses.create(
        input="Design a compact warehouse inspection drone that can hover for 15 minutes.",
        provider="openai",
    )
    print(response.output_text)

Repair SysML:

from sysmlv2copilot import SysMLCopilot

broken_sysml = """package Example {
  requirement def R { text = "Missing semicolon" }
}"""

with SysMLCopilot() as client:
    repaired = client.repairs.create(
        input=broken_sysml,
        provider="openai",
    )
    print(repaired.output_text)

CLI

Generate SysML from inline text:

sysmlv2copilot --api-key sysml_live_... \
  responses create \
  --input "Design a compact warehouse inspection drone that can hover for 15 minutes."

Repair SysML from a file:

sysmlv2copilot --api-key sysml_live_... \
  repairs create \
  --input-file ./broken.sysml

The CLI accepts .txt, .sysml, and .html files for --input-file. HTML files are converted to plain text before being sent to the API.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sysmlv2copilot-0.2.2.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sysmlv2copilot-0.2.2-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file sysmlv2copilot-0.2.2.tar.gz.

File metadata

  • Download URL: sysmlv2copilot-0.2.2.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for sysmlv2copilot-0.2.2.tar.gz
Algorithm Hash digest
SHA256 d5b885757c7036972eab927e4718f6ad042800464908df80776d9e829f9a5c8c
MD5 7410daa73a40590631ae3ab6eed0ed8c
BLAKE2b-256 c5be8bd99070a6affcb89bea991bbfea3f794e9aba4138217c31a063d58388e6

See more details on using hashes here.

File details

Details for the file sysmlv2copilot-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: sysmlv2copilot-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for sysmlv2copilot-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d993368357448fbc100fe893f670b4e9eb98cc32dc55364b6f01d26308e78c
MD5 bfdb07f368df6df7b480adbc95228268
BLAKE2b-256 3d61e791e9b3873870a910343cf47ddb2a7680b93a9dff9ef081192afbfd1eb4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page