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:

from sysmlv2copilot import generate, repair

sysml = generate(
    "Design a compact warehouse inspection drone that can hover for 15 minutes.",
    api_key="sysml_live_...",
)

repaired = repair(
    "broken.sysml",
    api_key="sysml_live_...",
)

Python

Generate SysML:

from sysmlv2copilot import generate

sysml = generate("Design a compact warehouse inspection drone that can hover for 15 minutes.")
print(sysml)

Repair SysML:

from pathlib import Path

from sysmlv2copilot import repair

repaired = repair(Path("broken.sysml"))
print(repaired)

You can pass:

  • raw strings
  • Path objects
  • path strings like "broken.sysml" or "requirements.html"
  • open text files

CLI

Generate SysML from inline text:

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

Repair SysML from a file:

sysmlv2copilot --api-key sysml_live_... \
  repair \
  --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.7.tar.gz (14.9 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.7-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.7.tar.gz
  • Upload date:
  • Size: 14.9 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.7.tar.gz
Algorithm Hash digest
SHA256 4341ac6ba393ca568f15e84b3fcb7fc69adcd5577fcc2e4d5ec7591803d42ab6
MD5 943dce6576a55f79647572ab9007a14c
BLAKE2b-256 85177a52deb5ec0d4a05e18136ee14b95a82164d9613fc46f02b836ba6931595

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 11.3 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c57b97ab1995597f51c7b288bbe62ffb2f186a72121aa94fc0a1a5d5c681441e
MD5 407cb90ddf64e3ac7b95f31381050815
BLAKE2b-256 2594276be4e55063d8a9a8e8f78e0bb810338cdd3d881f097670289adea9e021

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