Python API¶

The public API is intentionally small. Most applications import from the package root:

import molq as mq

Start with these¶

The reference is split by responsibility so individual pages stay navigable:

• Core API — Cluster, Submitor, and JobHandle.
• Job types — commands, resources, records, retry, retention, and queue entries.
• Supporting APIs — workspaces, configuration, SSH discovery, callbacks, plugins, and errors.

Stability boundary¶

Symbols exported by molq.__all__ are the supported package-level surface. Scheduler and transport protocols are useful for advanced integrations but are implementation-facing; ordinary users should construct them through Cluster.

Typical flow¶

import molq as mq

cluster = mq.Cluster("laptop", "local")

with mq.Submitor(target=cluster) as queue:
    job = queue.submit_job(
        argv=["python", "analyse.py"],
        execution=mq.JobExecution(job_name="analysis"),
    )
    record = job.wait()

if record.state is mq.JobState.SUCCEEDED:
    print("done")

For task-oriented explanations, start with Submit jobs or Monitor jobs.