Skip to main content

Thin Python client for the licensed YACS desktop engine

Project description

YACS Python client

yacs-client is the small, dependency-free Python interface to the licensed YACS desktop engine. It provides secure local discovery, background-job helpers, and a command-line interface. It contains no circuit solver or other proprietary YACS implementation code.

Install

Install into the Python environment that will automate YACS:

python -m pip install yacs-client

YACS Desktop must be installed and have a valid license. Installing this package does not install or unlock the solver.

Python API

from yacs_client import Desktop

with Desktop.connect() as yacs:
    result = yacs.analyze(circuit, analysis)

Long-running operations can be managed explicitly:

with Desktop.connect() as yacs:
    job = yacs.analyze(circuit, analysis, wait=False)
    print(job.status())
    result = job.result()

For large results, job.download("result.json") streams to a temporary file, verifies the engine-provided SHA-256 digest, and only then atomically replaces the destination.

CLI

yacs status
yacs analyze request.json --output result.json
yacs run refine_roots request.json --output roots.json

The v1 API accepts normalized JSON request objects. Complete .yacs workspace parsing remains engine-owned so client releases do not duplicate private or rapidly evolving desktop normalization rules.

Security boundary

The client connects only to numeric loopback addresses discovered through a private per-session descriptor. It rejects redirects, bypasses system HTTP proxies, verifies the engine instance handshake, and receives a scoped token that cannot access desktop or licensing-control endpoints.

The descriptor is a short-lived capability available to processes running as the same operating-system user. Do not copy or publish it.

Compatibility

Client releases are versioned independently from YACS Desktop. This release supports YACS Desktop Automation API v1.

Development and managed-installation overrides:

  • YACS_APP_PATH
  • YACS_CONNECTION_FILE
  • YACS_AUTOMATION_SESSION_DIR

License

The client is MIT licensed. YACS Desktop and its numerical engine are separate products governed by their own license terms.

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

yacs_client-0.1.0a1.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

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

yacs_client-0.1.0a1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file yacs_client-0.1.0a1.tar.gz.

File metadata

  • Download URL: yacs_client-0.1.0a1.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yacs_client-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 b8987f7d2740ebcc43b3b430b236021d966ff9f7a6b4c39b98b33b5b02319a76
MD5 24c490f172bd86ea44ba820c5860e2b2
BLAKE2b-256 33750b63d3cbfc7a2c8f4197d1d0c88c23ea007ff0a2165330f15773be5765a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for yacs_client-0.1.0a1.tar.gz:

Publisher: publish.yml on David-Pahl/yacs-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file yacs_client-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: yacs_client-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yacs_client-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 f228baf9e3c703310cebb3345e00f8e323b30b120830ef0d3844eef2a38655a4
MD5 3778fcb2bbdfdfb15d751b03290eb60b
BLAKE2b-256 5c4c1216d66e43665f2a60cfe8d5ab28fc019e033004263668bed8a12c871fca

See more details on using hashes here.

Provenance

The following attestation bundles were made for yacs_client-0.1.0a1-py3-none-any.whl:

Publisher: publish.yml on David-Pahl/yacs-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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