Release v0.11.0: read output via results.main_stuff

[lchoquel]

Summary

• Read a run's output with results.main_stuff. Bumped to pipelex-sdk 0.3.0, which resolves the main output for you on both execution modes: execute returns a PipelexExecuteResult and the durable path a RunResults, and both expose a resolved .main_stuff. The starter's whole output-extraction module (my_project/run_output.py — find_main_content shape-guessing + the to_run_results adapter) is gone; the CLI and the narrower read results.main_stuff directly, and the blocking execute result is adapted onto RunResults inline in the runner. A completed run that delivers no main stuff raises the SDK's MissingMainStuffError instead of yielding None.
• Breaking: renamed the env var PIPELEX_API_URL to PIPELEX_BASE_URL for consistency with the SDK's base_url naming. No read alias — update .env / environment.
• Fixed: rewrote the README and CLAUDE.md around the actual my-project CLI (the extract-entities command, durable/blocking execution modes, runs status|result|wait lifecycle). They still described the removed hello_world module, start_and_wait usage, and the find_main_content normalizer — the quick start's first command errored out for a fresh user.
• Repository: removed internal-only planning docs (TODOS.md, wip/) that must not ship in a "Use this template" repo.

⚠️ Merge-order note

This PR pins pipelex-sdk via a git+ssh ref to pipelex-sdk-python's release/v0.3.0 branch (unpublished — see that repo's PR). Recommend not merging this until pipelex-sdk-python's release/v0.3.0 PR has merged and published pipelex-sdk 0.3.0 to PyPI. I'll push a follow-up commit swapping the pin to a registry range (pipelex-sdk>=0.3.0) once it's live, so main never depends on a git pin.

Test plan

• make agent-check && make agent-test green
• Quick start re-verified: uv run my-project extract-entities "<text>"
• CHANGELOG.md updated

🤖 Generated with Claude Code

https://claude.ai/code/session_01PibWhJ6mPWdrkMqZATZpkJ

[greptile-apps]

Greptile Summary

This PR updates the starter around pipelex-sdk 0.3.0 and the new results.main_stuff output path. The main changes are:

• Uses results.main_stuff for completed run output in both blocking and durable modes.
• Replaces the old hello-world example with the my-project extract-entities CLI.
• Adds durable run lifecycle commands for runs status, runs result, and runs wait.
• Renames the API endpoint environment variable to PIPELEX_BASE_URL.
• Refreshes docs, tests, packaging metadata, and the lockfile for the new CLI flow.

Confidence Score: 5/5

Safe to merge with minimal risk.

The changed runtime paths consistently use the new SDK main_stuff contract, CLI mode dispatch is covered by tests, and package data includes the new method bundle.

No files require special attention.

T-Rex Logs

What T-Rex did

• T-Rex performed an environment presence check and confirmed the required Pipelex environment variables were unset.
• T-Rex ran the quick-start CLI and encountered a 401 credential blocker.
• T-Rex executed the fallback tests, resulting in 12 tests passing and 2 deselected.
• T-Rex collected test names to show coverage of the .main_stuff parse tests.

_{Ran code and verified through T-Rex}

Important Files Changed

Filename	Overview
README.md	Rewrites the starter quick start and architecture docs around the extract-entities CLI and run lifecycle commands.
my_project/cli.py	Adds a Typer CLI for extract-entities plus durable run status/result/wait commands; no blocking issues found.
my_project/errors.py	Adds SDK and HTTP error presentation with actionable CLI hints for auth, timeout, lifecycle, and connectivity failures.
my_project/examples/extract_entities.py	Adds the extract-entities example metadata and Pydantic result narrower based on results.main_stuff.
my_project/methods/extract-entities/main.mthds	Adds the extract_entities PipeLLM method and structured output concept for people, organizations, and dates.
my_project/runner.py	Adds blocking, durable attended, detached, and run-inspection SDK lifecycle wrappers with stderr progress output.
pyproject.toml	Bumps the project and SDK dependency, adds CLI/runtime dependencies, console script, package data, and test dependency updates.
tests/e2e/test_my_project.py	Replaces hello-world e2e coverage with durable and blocking extract-entities API runs.
tests/unit/test_cli.py	Adds offline CLI tests for help, input validation, execution-mode selection, file input, and detached start behavior.
uv.lock	Refreshes the lockfile for pipelex-sdk 0.3.0, Typer/Rich dependencies, and test dependency additions.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
actor User
participant CLI as my-project CLI
participant Runner as my_project.runner
participant SDK as PipelexAPIClient
participant API as Pipelex API

User->>CLI: extract-entities text / runs command
CLI->>CLI: load .env and read bundle
alt blocking mode
    CLI->>Runner: run_blocking(pipe_code, bundle, inputs)
    Runner->>SDK: execute(...)
    SDK->>API: POST /execute
    API-->>SDK: PipelexExecuteResult(main_stuff)
    Runner-->>CLI: RunResults(main_stuff)
else durable attended
    CLI->>Runner: run_durable_attended(...)
    Runner->>SDK: start(...)
    SDK->>API: create durable run
    API-->>SDK: pipeline_run_id
    Runner->>SDK: wait_for_result(run_id)
    SDK->>API: poll result state
    API-->>SDK: RunResults(main_stuff)
    Runner-->>CLI: RunResults(main_stuff)
else durable detached / resume
    CLI->>Runner: start_detached or wait_for_run(run_id)
    Runner->>SDK: start / get_run_status / get_run_result / wait_for_result
    SDK->>API: durable run lifecycle request
    API-->>SDK: run id, state, or RunResults
    Runner-->>CLI: lifecycle response
end
CLI->>CLI: parse or print results.main_stuff
CLI-->>User: JSON output or run status

Loading

%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
actor User
participant CLI as my-project CLI
participant Runner as my_project.runner
participant SDK as PipelexAPIClient
participant API as Pipelex API

User->>CLI: extract-entities text / runs command
CLI->>CLI: load .env and read bundle
alt blocking mode
    CLI->>Runner: run_blocking(pipe_code, bundle, inputs)
    Runner->>SDK: execute(...)
    SDK->>API: POST /execute
    API-->>SDK: PipelexExecuteResult(main_stuff)
    Runner-->>CLI: RunResults(main_stuff)
else durable attended
    CLI->>Runner: run_durable_attended(...)
    Runner->>SDK: start(...)
    SDK->>API: create durable run
    API-->>SDK: pipeline_run_id
    Runner->>SDK: wait_for_result(run_id)
    SDK->>API: poll result state
    API-->>SDK: RunResults(main_stuff)
    Runner-->>CLI: RunResults(main_stuff)
else durable detached / resume
    CLI->>Runner: start_detached or wait_for_run(run_id)
    Runner->>SDK: start / get_run_status / get_run_result / wait_for_result
    SDK->>API: durable run lifecycle request
    API-->>SDK: run id, state, or RunResults
    Runner-->>CLI: lifecycle response
end
CLI->>CLI: parse or print results.main_stuff
CLI-->>User: JSON output or run status

Loading

_{Reviews (2): Last reviewed commit: "chore: swap pipelex-sdk pin from git ref..." | Re-trigger Greptile}

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c1d26596bc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".