Skip to content

Add generate_api_text.py script#47203

Open
tjprescott wants to merge 3 commits into
mainfrom
GenerateAPITextScript
Open

Add generate_api_text.py script#47203
tjprescott wants to merge 3 commits into
mainfrom
GenerateAPITextScript

Conversation

@tjprescott
Copy link
Copy Markdown
Member

@tjprescott tjprescott commented May 28, 2026

  • Adds a script to help generate API.md. This will be used as the basis for other work to generate API reviews through Github.
  • Adds a script that generates the proper branch structure for PR-based API reviews.

Examples

Auto Review - #47236

PR Review - #47242

Initial (New Package) Review - #47238

@tjprescott tjprescott requested a review from kashifkhan May 28, 2026 16:55
@tjprescott tjprescott requested a review from scbedd as a code owner May 28, 2026 16:55
Copilot AI review requested due to automatic review settings May 28, 2026 16:55
@tjprescott tjprescott requested a review from danieljurek as a code owner May 28, 2026 16:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new repo script (scripts/generate_api_text.py) to generate a package-level API.md by building a wheel, running apiview-stub-generator (apistub) to produce the token JSON, and converting that JSON to markdown via Export-APIViewMarkdown.ps1. This is repo tooling intended to streamline API review artifact generation.

Changes:

  • Introduces scripts/generate_api_text.py to locate a package under sdk/*/, build a wheel, run apistub, and emit API.md into the package directory.
  • Adds logic to install eng/apiview_reqs.txt and (optionally) upgrade apiview-stub-generator from the Azure SDK package index.
  • Uses eng/common/scripts/Export-APIViewMarkdown.ps1 to convert the generated *_python.json token file into markdown.

Comment thread scripts/generate_api_text.py
Comment thread scripts/generate_api_text.py
Comment thread scripts/generate_api_text.py
Comment thread scripts/generate_api_text.py
Comment thread scripts/generate_api_text.py
Comment thread scripts/generate_api_text.py Outdated
Comment thread scripts/generate_api_text.py
@tjprescott tjprescott force-pushed the GenerateAPITextScript branch 3 times, most recently from 7c45b15 to b9dc383 Compare May 29, 2026 19:55
@tjprescott tjprescott force-pushed the GenerateAPITextScript branch from b9dc383 to ebb3870 Compare May 29, 2026 20:09
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.

2 participants