modelcontextprotocol/python-sdk
Watch
1
0
Fork
You've already forked python-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Promote the v2 README to README.md ahead of the first v2 beta (#3014)

Browse source
This commit is contained in:
Max 2026-06-29 13:01:54 +02:00 • committed by GitHub
commit f2e63c979a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 84 additions and 2683 deletions
Download patch file Download diff file Expand all files Collapse all files

8
scripts/update_readme_snippets.py
View file

@ -93,16 +93,16 @@ def process_snippet_block(match: re.Match[str], check_mode: bool = False) -> str
return full_match
def update_readme_snippets(readme_path: Path = Path("README.md"), check_mode: bool = False) -> bool:
def update_readme_snippets(check_mode: bool = False) -> bool:
"""Update code snippets in README.md with live code from source files.
Args:
readme_path: Path to the README file
check_mode: If True, only check if updates are needed without modifying
Returns:
True if file is up to date or was updated, False if check failed
"""
readme_path = Path("README.md")
if not readme_path.exists():
print(f"Error: README file not found: {readme_path}")
return False
@ -146,12 +146,10 @@ def main():
parser.add_argument(
"--check", action="store_true", help="Check mode - verify snippets are up to date without modifying"
)
# TODO(v2): Drop the `--readme` argument when v2 is released, and set to `README.md`.
parser.add_argument("--readme", default="README.v2.md", help="Path to README file (default: README.v2.md)")
args = parser.parse_args()
success = update_readme_snippets(Path(args.readme), check_mode=args.check)
success = update_readme_snippets(check_mode=args.check)
if not success:
sys.exit(1)