harnest.orchestrator

All Python modules · Import and compatibility guidance

Exports

Name	Kind
`AgentSource`	Class
`Orchestrator`	Class
`define_orchestrator`	Function

AgentSource

Select agent directories included in a deployment plan.

AgentSource(root: str, include: Sequence[str] = ..., exclude: Sequence[str] = ...) -> None

Fields (— means no declared default):

Field	Type	Default
`root`	`str`	`—`
`include`	`Sequence[str]`	`<lambda>()`
`exclude`	`Sequence[str]`	`tuple()`

Parameters and example

Parameter	Type	Default
`root`	`str`	Required
`include`	`Sequence[str]`	`...`
`exclude`	`Sequence[str]`	`...`

from harnest.orchestrator import AgentSource

source = AgentSource(root=...)

AgentSource.directory

AgentSource.directory(root: str, *, include: Sequence[str] = ('*',), exclude: Sequence[str] = ()) -> 'AgentSource'

Create a directory source with optional include and exclude globs.

Parameters and example

Parameter	Type	Default
`root`	`str`	Required
`include`	`Sequence[str]`	`('*',)`
`exclude`	`Sequence[str]`	`()`

from harnest.orchestrator import AgentSource

source = AgentSource.directory(root=...)

Orchestrator

Describe a deterministic multi-agent deployment plan.

Orchestrator(
    sources: Sequence[AgentSource | str],
    parallelism: int = 4,
    fail_fast: bool = False,
    labels: Mapping[str, str] = ...,
) -> None

Fields (— means no declared default):

Field	Type	Default
`sources`	`Sequence[AgentSource \| str]`	`—`
`parallelism`	`int`	`4`
`fail_fast`	`bool`	`False`
`labels`	`Mapping[str, str]`	`dict()`

Parameters and example

Parameter	Type	Default
`sources`	`Sequence[AgentSource \| str]`	Required
`parallelism`	`int`	`4`
`fail_fast`	`bool`	`False`
`labels`	`Mapping[str, str]`	`...`

from harnest.orchestrator import Orchestrator

orchestrator = Orchestrator(sources=...)

Orchestrator.plan

Orchestrator.plan(*, project_root: str | Path) -> dict[str, Any]

Build the JSON-compatible deployment plan for a project root.

Parameters and example

Parameter	Type	Default
`project_root`	`str \| Path`	Required

from harnest.orchestrator import Orchestrator

orchestrator: Orchestrator
result = orchestrator.plan(project_root=...)

Orchestrator.to_json

Orchestrator.to_json(*, project_root: str | Path) -> str

Serialize the deployment plan as stable, human-readable JSON.

Parameters and example

Parameter	Type	Default
`project_root`	`str \| Path`	Required

from harnest.orchestrator import Orchestrator

orchestrator: Orchestrator
result = orchestrator.to_json(project_root=...)

define_orchestrator

Create an orchestrator from agent directory sources and plan options.

define_orchestrator(
    *,
    agents: Sequence[AgentSource | str],
    parallelism: int = 4,
    fail_fast: bool = False,
    labels: Mapping[str, str] | None = None,
) -> Orchestrator

Parameters and example

Parameter	Type	Default
`agents`	`Sequence[AgentSource \| str]`	Required
`parallelism`	`int`	`4`
`fail_fast`	`bool`	`False`
`labels`	`Mapping[str, str] \| None`	`None`

from harnest.orchestrator import define_orchestrator

orchestrator = define_orchestrator(agents=...)

Overview

Get started

Harnest Studio

Guides

API reference

harnest.orchestrator

Exports

AgentSource

AgentSource.directory

Orchestrator

Orchestrator.plan

Orchestrator.to_json

define_orchestrator

​Exports

​AgentSource

​AgentSource.directory

​Orchestrator

​Orchestrator.plan

​Orchestrator.to_json

​define_orchestrator

Exports

AgentSource

AgentSource.directory

Orchestrator

Orchestrator.plan

Orchestrator.to_json

define_orchestrator