Skip to content

Annotate eth-brownie/brownie entry with deprecation notice + migration tooling#173

Open
PugarHuda wants to merge 1 commit into
bkrem:gh-pagesfrom
PugarHuda:add-brownie-to-ape-codemod
Open

Annotate eth-brownie/brownie entry with deprecation notice + migration tooling#173
PugarHuda wants to merge 1 commit into
bkrem:gh-pagesfrom
PugarHuda:add-brownie-to-ape-codemod

Conversation

@PugarHuda
Copy link
Copy Markdown

Summary

1-line annotation to the existing eth-brownie/brownie entry in the Tools section, noting:

  1. Brownie was officially deprecated in 2023 (the deprecation is in the project's own README, but readers of this list don't see it without clicking through).
  2. Users are directed to ApeWorx Ape — the recommended successor.
  3. For automated migration, @pugarhuda/brownie-to-ape is a community-built codemod that automates 80–95% of the Brownie → Ape pattern rewrites with zero false positives.

Why this is useful

The list currently shows Brownie as a current/active framework, which can mislead readers picking a Solidity development tool today. The 1-line note keeps Brownie in the list (it's still relevant for understanding existing codebases) while giving readers the actual recommended path forward.

Format / scope

  • Purely additive. Only appends an italicised parenthetical after the existing one-line description.
  • Doesn't remove the Brownie entry — it still appears with its original description.
  • Doesn't introduce new sections or restructure anything.

About the migration codemod referenced

Built for the Codemod "Boring AI" hackathon (DoraHacks 2026), validated on 5 OSS Brownie projects including yearn/brownie-strategy-mix with 0 false positives. End-to-end verified: after the codemod plus a small AI/manual cleanup pass, ape compile succeeds and ape test --network ::test returns 38 passed / 0 failed in 5.40s on brownie-mix/token-mix (passing log).

🤖 Generated with Claude Code

Brownie was officially deprecated in 2023 (see project's own README:
https://github.com/eth-brownie/brownie/blob/master/README.md), with
users directed to ApeWorx Ape. This adds a 1-line parenthetical note
to the existing Brownie entry so users see both the deprecation
status and the community-built migration codemod
(@pugarhuda/brownie-to-ape) without having to find them separately.

The change is purely additive -- only adds an italicised note after
the existing description; doesn't remove or modify any other content.
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.

1 participant