Skip to content

docs: point the PyPI links at agentenvframework.com and title the README AgentEnv Framework - #30

Merged
earakely-scale merged 2 commits into
mainfrom
docs/pypi-links-and-readme-title
Sep 30, 2026
Merged

earakely-scale merged 2 commits into
mainfrom
docs/pypi-links-and-readme-title

Conversation

@earakely-scale

@earakely-scale earakely-scale commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

Changes

  • PyPI project links for both agentenv-framework and agentenv-framework-protocol:
  • README (also the PyPI project page):
    • The logo is now a banner: 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 on prefers-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 absolute main URL, because PyPI can't resolve relative paths, so GitHub shows it once this merges.
    • The title (the banner) and the first sentence name the product AgentEnv Framework instead of agent-env. agent-env stays the name of the command and the code.
    • The second sentence names the protocol by its published distribution, agentenv-framework-protocol. The old agentenv-protocol was never on PyPI.

Verification

  • Built both packages with uv build:
    • each wheel's METADATA lists the four Project-URLs above
    • the framework's long description opens with # AgentEnv Framework
  • twine check --strict passes on both wheels and both sdists.
  • uv lock --check passes: the lockfile is unaffected.
  • tst/unit/test_check_plugin_api.py, which parses the README, passes.
  • I previewed the banner at README width on GitHub's light (#ffffff) and dark (#0d1117) backgrounds, and it reads on both.

bump-version is set so the new links and title reach PyPI.

🤖 Generated with Claude Code

RetriggerConfidence Score: 4/5

The PR appears safe to merge, though the README introduction should make clear which package builds and deploys environments.

Fix All in CursorFindings

  1. P2 Protocol gets framework credit ▶
Fix with agent prompt
### Issue 1
README.md:3
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.
```

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!

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

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.

  • Both packages point their Homepage links to the project site and add a Documentation link.
  • The README opening names AgentEnv Framework and agentenv-framework-protocol.

Reviews (1) · Last reviewed commit: "docs: title the README with text instead..."

…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>
@earakely-scale
earakely-scale requested a review from a team as a code owner September 30, 2026 22:15
@earakely-scale earakely-scale added documentation Improvements or additions to documentation bump-version labels Sep 30, 2026
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>
@earakely-scale
earakely-scale merged commit b25ee32 into main Sep 30, 2026
9 of 11 checks passed
@earakely-scale
earakely-scale deleted the docs/pypi-links-and-readme-title branch September 30, 2026 22:19
Comment thread README.md
# 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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!

Fix in Cursor Fix in Claude Code Fix in Codex

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, the "it" read as the protocol. Fixed with your wording in #31, which also restores the README logo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump-version documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant