fix: use separate READMEs for Python and TypeScript packages#2384
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Assessment: Comment The overall approach is solid — giving each SDK its own README for package registries is the right fix for the npmjs.com rendering problem, and the LICENSE/NOTICE bundling via Review Themes
|
The shared root README contained only Python examples, which would display incorrectly on npmjs.com. Each SDK now has its own README pulled from history — the Python one from the pre-monorepo root and the TypeScript one from sdk-typescript before its merge. The root README remains as the monorepo landing page. Each package README has the appropriate SDK title, badges, code examples, and links for its respective ecosystem. Also fixes strands-agents#2351 by ensuring LICENSE and NOTICE are copied at build time for the Python wheel. Closes strands-agents#2351
87cf775 to
7b3f294
Compare
|
Updated Assessment: Approve ✅ After fuller review, I'm correcting my earlier feedback. The README links are already using absolute GitHub URLs — my initial comments about broken relative links were incorrect (based on a truncated diff). I've replied to those threads with corrections. The only remaining suggestion is the minor local-build ergonomics note about This PR cleanly solves #2351 with well-structured CI changes and properly separated READMEs for each package registry. |
Description
The shared root README contains only Python examples, which displays incorrectly on npmjs.com for the TypeScript SDK. It also doesn't mention TypeScript features at all. Each SDK now has its own README committed in its package directory, pulled from git history (the Python one from the pre-monorepo root, the TypeScript one from sdk-typescript before the merge).
The root README stays as the monorepo landing page with the directory table. Each package README has the correct SDK title, badges, code examples, and documentation links for its ecosystem.
This also fixes the LICENSE/NOTICE bundling for the Python wheel — the CI workflows copy
LICENSE.APACHEandNOTICEfrom the root at build time, andpyproject.tomlnow declareslicense-filesso they get included in the wheel'slicenses/directory.Resolves: #2351
Related Issues
#2351, #2286
Type of Change
Bug fix
Testing
Built Python wheel, verified it contains
licenses/LICENSE,licenses/NOTICE, and METADATA shows "Strands Agents - Python SDK" title with full markdown descriptionRan
npm pack --dry-runin strands-ts, verified tarball containsREADME.md(11.3kB, TypeScript-specific) andLICENSEtwine checkpasses for both wheel and sdistPre-commit hooks pass (TS build + test suite)
I ran
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.