Skip to content

docs(readme): lead with the sandbox category and add package keywords - #840

Merged
james-rl merged 1 commit into
mainfrom
docs/sdk-discoverability
Sep 4, 2026
Merged

docs(readme): lead with the sandbox category and add package keywords#840
james-rl merged 1 commit into
mainfrom
docs/sdk-discoverability

Conversation

@james-rl

@james-rl james-rl commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Why

Coding agents pick sandbox providers mostly through web and package-registry retrieval, not training priors. Today this repo gives that retrieval almost nothing to work with: the README opened with generated-client boilerplate, the PyPI description was "The official Python library for the runloop API", keywords was empty, and the docs links pointed at the marketing site and the typedoc page rather than docs.runloop.ai.

What changed

README.md

  • Title and opening paragraph now say what Runloop is: secure, isolated Linux sandboxes (Devboxes) for AI agents.
  • Short "Why teams pick Runloop" list in plain language — VM + container isolation, long-running devboxes with snapshots, fast starts via blueprints, secrets/AI gateways/network policies/VPC, built-in benchmarks.
  • First screen is now category statement → pip install → a working quickstart that creates a devbox, writes a file, and runs it.
  • Docs section links platform docs, the SDK reference, api.md, examples/, and llms.txt. Stainless/httpx boilerplate moved below the quickstart.

pyproject.toml

  • description names the category.
  • keywords added (was empty): sandbox, devbox, ai-agents, code-execution, code-interpreter, agent-runtime, microvm, llm.
  • Added the AI classifier; Homepage → runloop.ai, Documentation → docs.runloop.ai, typedoc site kept as "API Reference".

Repo topics and the GitHub description/homepage were updated separately through the API — those aren't files.

Notes

  • The quickstart uses the real devbox.file.write(...) / devbox.cmd.exec(...) API, checked against src/runloop_api_client/sdk/devbox.py.
  • Both touched surfaces are Stainless-generated. These edits will be lost on the next generation unless mirrored in the Stainless config — worth doing as a follow-up.
  • The same treatment is still pending on runloopai/api-client-ts.

🤖 Generated with Claude Code

Agents choosing a sandbox rely heavily on web/registry retrieval, and the
Python SDK's README, PyPI description, and repo metadata never named the
category. Lead the README with what Runloop does, list the concrete
advantages, and put install + a working quickstart on the first screen.
Add PyPI keywords (previously empty) and point the docs links at
docs.runloop.ai.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Co-authored-by: Reflex <reflex@runloop.ai>
@reflex-loop

reflex-loop Bot commented Sep 4, 2026

Copy link
Copy Markdown

Reflex agent status: Completed

Agent Status
agt_2anPjrkbO75aTzpvtN6Hch ✅ Completed

This PR was created by Reflex.

This comment updates in place as agents work.

@james-rl
james-rl requested review from dines-rl and tode-rl September 4, 2026 01:09
@james-rl
james-rl merged commit 8353d09 into main Sep 4, 2026
7 checks passed
@james-rl
james-rl deleted the docs/sdk-discoverability branch September 4, 2026 01:17
@tode-rl tode-rl mentioned this pull request Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants