Yield

Yield for Python

Move repeatable coding-agent instructions from words into Python.

Build typed, resumable workflows that stay beside the code they operate on.

PyPI version Python versions Build status MIT license

Website · Documentation · PyPI · GitHub

The package name and import name are both yieldskill. Python reserves yield as a keyword.

Start with your coding agent

uvx --from yieldskill yskill bootstrap --language python

Review and confirm the plan. Restart your coding agent. Then ask it to create a new skill workflow:

Use Yield to create a tested skill workflow for releasing my package.

To convert an existing SKILL.md, ask:

Use Yield to convert my existing release SKILL.md into a tested skill workflow.

Advanced: build manually

1. Install Yield

Yield supports Python 3.10 or later on macOS, Linux, and Windows. Create a virtual environment and install the public package:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install yieldskill
python -m yieldskill --version

On Windows PowerShell:

py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install yieldskill
python -m yieldskill --version

Each wheel contains the matching yskill runtime for its platform. You do not need Go, Node.js, or a separate CLI installation.

2. Create the workflow

Create a Python workflow inside your repository:

python -m yieldskill init skills/env-doctor \
  --language python \
  --description "Check the Python environment and explain the required fix."

Replace skills/env-doctor/main.py with this tested workflow:

from yieldskill import define_skill

def program(ctx):
    probe = ctx.run_command(
        "probe-python", "python3 --version || python --version", timeout_seconds=60
    )

    diagnosis = ctx.agent_task(
        "diagnose",
        "Given the probe output, is this environment healthy for the project? "
        "If not, state the single most likely fix.",
        context={"exit_code": probe.exit_code, "stdout": probe.stdout, "stderr": probe.stderr},
        schema={
            "type": "object",
            "required": ["healthy"],
            "properties": {
                "healthy": {"type": "boolean"},
                "fix_hint": {"type": "string"},
            },
        },
    )

    if not diagnosis["healthy"]:
        answer = ctx.ask_user(
            "apply-fix",
            f"The environment needs a fix: {diagnosis.get('fix_hint', 'unknown')}. Apply it now and reply done.",
            options=[{"value": "done"}, {"value": "skip"}],
        )
        if answer != "done":
            ctx.blocked("the environment fix was not applied")
        recheck = ctx.run_command(
            "recheck-python", "python3 --version || python --version", timeout_seconds=60
        )
        ctx.require(recheck.exit_code == 0, "the environment probe passes after the fix", recheck)
        return {"healthy": True, "fixed": True}

    ctx.require(probe.exit_code == 0, "the environment probe passes", probe)
    return {"healthy": True, "fixed": False}


define_skill(program)

The generated skill.json declares Python as the runner. The generated SKILL.md tells a coding agent how to start and resume the workflow.

3. Test the workflow

Use deterministic fixture responses during tests. Save this as skills/env-doctor/fixtures/responses.json:

{
  "diagnose": { "healthy": true }
}

Then test the workflow:

python -m yieldskill doctor skills/env-doctor --test

Yield runs commands for real and supplies agent and user responses from the fixture. A successful test reaches completed without leaving a run journal.

4. Register the skill

Registration lets installed coding agents discover the workflow:

python -m yieldskill register skills/env-doctor

Select the verified agents explicitly when you do not want automatic detection:

python -m yieldskill register skills/env-doctor \
  --agent cursor,codex,claude-code

The generated adapters point back to skills/env-doctor. They do not copy the workflow or install its dependencies again.

5. Run the skill

Start a new coding-agent session so it discovers the registered skill. Where slash skills are supported, run:

/env-doctor

Otherwise, ask the agent in plain language:

Use the env-doctor skill to check this project.

The agent follows the adapter, starts the canonical Python workflow, and asks for each required agent or user response.

How Yield runs and resumes

  1. Your Python function emits one typed operation.
  2. Yield records the request and exits. It does not run a daemon.
  3. The coding agent, user, or CLI supplies the result.
  4. Yield replays the function from its journal until it reaches the next operation.

Replay must produce the same operation sequence. Yield reports divergence instead of giving a recorded response to a different operation.

Where AgentTask fits

ctx.agent_task() delegates one bounded judgment to the coding agent. Pass important evidence explicitly, as this workflow passes the probe result. With its schema, Yield checks the returned JSON shape before the workflow continues; it does not prove the diagnosis is correct. Host workspace and conversation access are host-dependent.

Python primitive Purpose
ctx.run_command() Execute a command and record its exit code and output.
ctx.agent_task() Delegate one bounded judgment; an optional schema validates the result.
ctx.ask_user() Request an explicit human decision.
ctx.require() Bind a required claim to recorded evidence.
ctx.blocked() / ctx.refused() Stop honestly when work cannot or must not continue.

See the primitive guides and CLI reference for the complete contract.

Guarantees and limits

Yield provides deterministic control flow, typed requests and responses, persistent run state, replay with divergence detection, stale and duplicate response rejection, and evidence-bound completion.

Schema validity is not truth. Yield cannot prove that a coding agent performed only the requested work. run_command is different: the Yield CLI executes the command, so its recorded exit code and output are observed facts.

Programs must remain deterministic between operations. Do not read clocks, random values, environment variables, or changing files to choose the next operation. Cross those boundaries through a Yield operation instead.

Yield is not a daemon, hosted runtime, workflow DSL, marketplace, coding-agent loop, multi-agent orchestrator, or security sandbox.

Coding agents and source

Cursor, Codex, and Claude Code are verified integrations. Yield also provides registry-backed project paths for other coding agents; those paths are not presented as end-to-end verified.

Yield is available under the MIT license.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.5.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for bigboateng from gravatar.com bigboateng

Credits

Author: OperatorStack

Maintainer: Boateng Opoku-Yeboah

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Tags

coding agents skills workflows

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

yieldskill-0.4.0-py3-none-win_arm64.whl (1.7 MB view details)

Uploaded Python 3Windows ARM64

yieldskill-0.4.0-py3-none-win_amd64.whl (2.0 MB view details)

Uploaded Python 3Windows x86-64

yieldskill-0.4.0-py3-none-manylinux_2_17_x86_64.whl (1.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

yieldskill-0.4.0-py3-none-manylinux_2_17_aarch64.whl (1.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

yieldskill-0.4.0-py3-none-macosx_11_0_x86_64.whl (1.9 MB view details)

Uploaded Python 3macOS 11.0+ x86-64

yieldskill-0.4.0-py3-none-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

Details for the file yieldskill-0.4.0-py3-none-win_arm64.whl.

File metadata

  • Download URL: yieldskill-0.4.0-py3-none-win_arm64.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for yieldskill-0.4.0-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 c03a7dab68fc4cbcdd46cf4aa2210051d9065f8b60f42a5efd81e531ed7ecaf1
MD5 f980cc08429b4f10e791292549dc5392
BLAKE2b-256 b741cf985b47f624a54e3b5b5339a24230ccc70f6e89b414dc434d32ef324c1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-win_arm64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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

File details

Details for the file yieldskill-0.4.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: yieldskill-0.4.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for yieldskill-0.4.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6b322c803b4ae93851626a0fa6d91eded5bc512d52ac41780057d4dd22bf895e
MD5 eb7d4fc12bfa144fceccd5b20ea2b024
BLAKE2b-256 0a07c49174c6a30f71870da71609922d0232f38c5a4405bedd8e5a7ab588ba1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-win_amd64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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

File details

Details for the file yieldskill-0.4.0-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for yieldskill-0.4.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 9465fefc962acda034059729f5cc84c5304ec20de63c2284e7905c9cea481876
MD5 bcd3a6c065dbedbff4c0f119bd46b073
BLAKE2b-256 49ac814fa6073815b753f572f8ee22b2a63868524500ceff07eecad4575028c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-manylinux_2_17_x86_64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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

File details

Details for the file yieldskill-0.4.0-py3-none-manylinux_2_17_aarch64.whl.

File metadata

File hashes

Hashes for yieldskill-0.4.0-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 8ab141d483ec4767b61a3f2d8d037088a23b68b116358e744e952ba4214dfb20
MD5 6cc06ddc0aa42ad0a7fa805acae265ad
BLAKE2b-256 de6008c50cd0558dfe9eb98538b8cb3e4bacb2c3a85a9ea5e532942855bad771

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-manylinux_2_17_aarch64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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

File details

Details for the file yieldskill-0.4.0-py3-none-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for yieldskill-0.4.0-py3-none-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 c8d35dda55daa37e9af654aa00bd7929a9edc13aad9e207eff70f8099a73e298
MD5 082d1af66116f3ae01a1e7b7e60b6529
BLAKE2b-256 7ff5ceb4d40418cfe5758cd375bfdd67a080bfa048923a94bc734d7ddf7bd92d

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-macosx_11_0_x86_64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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

File details

Details for the file yieldskill-0.4.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for yieldskill-0.4.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 71cf95458d494816a8473addc9f7cec6ed12bcff9d3141ede014d2f23d408a64
MD5 ff3ac3cfc77069e2a55aec13a11bb213
BLAKE2b-256 fc6fbb470c78e24c99fd173584ec931dd8959fe59275ffe87cdfa919289f284b

See more details on using hashes here.

Provenance

The following attestation bundles were made for yieldskill-0.4.0-py3-none-macosx_11_0_arm64.whl:

Publisher: npm-publish.yml on operatorstack/yield

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