A stub generator for published APIs, variables and properties in a package
Project description
API Stub Generator ![Build Status](https://pypi-camo.freetls.fastly.net/6b3ccbda4d8b9abae9cf386e8ec58f1f233b2f77/68747470733a2f2f6465762e617a7572652e636f6d2f617a7572652d73646b2f7075626c69632f5f617069732f6275696c642f7374617475732f3130383f6272616e63684e616d653d6d6173746572)
Azure SDK API review tool is used to review all published Azure SDK APIs and this review tool works for all language format. API tool needs a stub file generated in json format with tokens to list APIs in review tool. API stub generator package is developed to create a stub file with api surface level information. Following are the main published components included in this stub file.
- Classes and module level functions
- Instance methods
- Class and Instance variables
- Properties
Steps to create API review
Following are the steps to create an API review request for python package.
- Generate stub file tokens
- Upload stub file tokens into API review portal
Generate stub File
apiview-stub-generator
package is used to generate stub file tokens from either source code repo or from prebuilt wheel package. Following are the steps to generate stub file token.
Install apiview-stub-generator
package. From the root of the apiview-stub-generator package, run:
pip install . --extra-index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"
Run apistubgen
command with source repo or whl package as parameter and this will generate a json file with tokens.
Help for apistubgen
apistubgen --pkg-path <path to package root>
This also takes an optional parameter to mention output path where json token file will be generated. If out-path is not given then file will be generated in current working directory.
apistubgen --pkg-path <path to package root> --out-path <Outpath path>
Sample:
apistubgen --pkg-path C:\git\azure-sdk-for-python\sdk\core\azure-core
apistubgen --pkg-path C:\git\azure-sdk-for-python\sdk\core\azure-core --out-path C:\out
Token file will be created with a naming convention `_python.json'
Upload token file to API review portal
- Go to
https://apiview.dev
- Click on
Create review
- Select generated token file and upload
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for apiview_stub_generator-0.3.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 312a7f1efc93130d74ef87f9f4e3d49b7f9f06d28b1d495b6c1a64dc9b575c02 |
|
MD5 | de0cc4e7e244ed9456dd23a8f288f8a9 |
|
BLAKE2b-256 | a1175450406f532ea7c6aa03afcbb202e5ee90a4908da2425a5e9458c444548e |