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_... \
  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.3.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.3-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 d2c64f6618ca158136dd880f9d0400fa4f72f524bfbfae9be33f420a1313c8bd
MD5 737aae18cdd9a21da84b7fc58a7d2a6a
BLAKE2b-256 d4535de70e89f679343aeae0909946b7d17f47f28468ab3daa9a0f911e84b9a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sysmlv2copilot-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8d70c38086148366ce29ff9bd274f6ee3480e4a9963a8accf24eb4083a63abe3
MD5 09067b80884a69557ce290b75a9f61ef
BLAKE2b-256 9cc128504a392376a8bcc8c934317fa1877f85e20741f074387ef4cba840fbd2

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