Repository navigation
docs: point the PyPI links at agentenvframework.com and title the README AgentEnv Framework - #30
Merged
Merged
Conversation
…DME AgentEnv Framework Both packages' Homepage now points at the site instead of the repository, and both gain a Documentation link to the docs. The README, which is also the PyPI page, is titled and opens with the product name, and names the protocol by its published distribution, agentenv-framework-protocol. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The lockup switched variants on prefers-color-scheme, which follows the operating system, not GitHub's theme: with GitHub on dark and the OS on light, it showed the black wordmark on a dark page. The text title reads in every theme, on GitHub and PyPI, and no longer repeats the name under the wordmark. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| # agent-env | ||
|
|
||
| agent-env is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-protocol`; agent-env builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did. | ||
| AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; it builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did. |
There was a problem hiding this comment.
Protocol gets framework credit
The new introduction puts it right after agentenv-framework-protocol, making it sound as though that package builds images, deploys environments, and scores agents. Those are framework features. Name AgentEnv Framework again so readers can tell which package does the work.
Suggested change
| AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; it builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did. | |
| AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; AgentEnv Framework builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 3
Comment:
**Protocol gets framework credit**
The new introduction puts `it` right after `agentenv-framework-protocol`, making it sound as though that package builds images, deploys environments, and scores agents. Those are framework features. Name `AgentEnv Framework` again so readers can tell which package does the work.
```suggestion
AgentEnv Framework is a Python SDK and CLI for building, deploying and running agentic environments and the tasks that grade agents inside them. Environments are containerized servers that speak the open `agentenv-framework-protocol`; AgentEnv Framework builds them into versioned images, deploys them behind a gateway, points an agent at them, and scores what the agent did.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Collaborator
Author
There was a problem hiding this comment.
Agreed, the "it" read as the protocol. Fixed with your wording in #31, which also restores the README logo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
agentenv-frameworkandagentenv-framework-protocol:assets/brand/readme-banner.png, cut from the social preview. It carries its own dark background and rounded corners, and it's the README's<h1>, with "AgentEnv Framework" as its alt text. The old<picture>switched between the light and dark lockups onprefers-color-scheme. That follows the operating system, not GitHub's theme, so a visitor with GitHub on dark and their OS on light saw a black wordmark on a dark page. The banner looks the same in both GitHub themes and on PyPI. It uses an absolutemainURL, because PyPI can't resolve relative paths, so GitHub shows it once this merges.agent-env.agent-envstays the name of the command and the code.agentenv-framework-protocol. The oldagentenv-protocolwas never on PyPI.Verification
uv build:METADATAlists the fourProject-URLs above# AgentEnv Frameworktwine check --strictpasses on both wheels and both sdists.uv lock --checkpasses: the lockfile is unaffected.tst/unit/test_check_plugin_api.py, which parses the README, passes.#ffffff) and dark (#0d1117) backgrounds, and it reads on both.bump-versionis set so the new links and title reach PyPI.🤖 Generated with Claude Code
The PR appears safe to merge, though the README introduction should make clear which package builds and deploys environments.
Fix with agent prompt
Summary
Both PyPI packages now link to AgentEnv’s website and docs. The README introduces AgentEnv Framework and names its protocol by its published distribution name.
agentenv-framework-protocol.Reviews (1) · Last reviewed commit: "docs: title the README with text instead..."