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 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.5.tar.gz (15.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.5-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.5.tar.gz
  • Upload date:
  • Size: 15.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.5.tar.gz
Algorithm Hash digest
SHA256 1384ecaa90c65fc7ded749a463f407c171e4bb1829846aae9c07873fa20b0e99
MD5 7bcdf2f01562a1164e62197d5e23a0bc
BLAKE2b-256 d396ffcde823a59568496258a317261fdfc0169f77ef7f256078949358e9dfe8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9882a8c863688592a821bd956932aac0f3ccce50d065ae2ba8c051bf84a8f4d3
MD5 43edff1a707ef574323631c07fd9a86f
BLAKE2b-256 e5e848f74462c31049026fa0b308d923125e99565eee33c9043d74882ef1163d

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