Rename `api-stub-generator` to `apiview-stub-generator` (#5899)
This commit is contained in:
Родитель
e3d5beb8cd
Коммит
6ccd535dc6
|
@ -41,7 +41,7 @@ stages:
|
|||
displayName: 'Setup Python Environment'
|
||||
|
||||
- pwsh: |
|
||||
Write-Host "Bundling stable version of python api-stub-generator"
|
||||
Write-Host "Bundling stable version of python apiview-stub-generator"
|
||||
python setup.py bdist_wheel --universal --dist-dir $(Build.ArtifactStagingDirectory)
|
||||
displayName: 'Build ${{ parameters.PackageName }}'
|
||||
workingDirectory: $(Build.SourcesDirectory)/${{ parameters.PackagePath }}
|
||||
|
|
|
@ -36,7 +36,7 @@ if __name__ == '__main__':
|
|||
warning_color = '\033[91m'
|
||||
end_color = '\033[0m'
|
||||
|
||||
stub_gen_path = os.path.join(ROOT, 'packages', 'python-packages', 'api-stub-generator')
|
||||
stub_gen_path = os.path.join(ROOT, 'packages', 'python-packages', 'apiview-stub-generator')
|
||||
changelog_path = os.path.join(stub_gen_path, "CHANGELOG.md")
|
||||
version_path = os.path.join(stub_gen_path, 'apistub', '_version.py')
|
||||
|
||||
|
|
|
@ -20,7 +20,7 @@ if __name__ == '__main__':
|
|||
warning_color = '\033[91m'
|
||||
end_color = '\033[0m'
|
||||
|
||||
stub_gen_path = os.path.join(ROOT, 'packages', 'python-packages', 'api-stub-generator')
|
||||
stub_gen_path = os.path.join(ROOT, 'packages', 'python-packages', 'apiview-stub-generator')
|
||||
changelog_path = os.path.join(stub_gen_path, "CHANGELOG.md")
|
||||
version_path = os.path.join(stub_gen_path, 'apistub', '_version.py')
|
||||
|
||||
|
|
|
@ -14,9 +14,9 @@ Following are the steps to create an API review request for python package.
|
|||
2. Upload stub file tokens into API review portal
|
||||
|
||||
### Generate stub File
|
||||
`api-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.
|
||||
`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 `api-stub-generator` package. From the root of the api-stub-generator package, run:
|
||||
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/"
|
||||
```
|
|
@ -23,7 +23,7 @@ __all__ = [
|
|||
|
||||
|
||||
def console_entry_point():
|
||||
print("Running api-stub-generator version {}".format(__version__))
|
||||
print("Running apiview-stub-generator version {}".format(__version__))
|
||||
stub_generator = StubGenerator()
|
||||
apiview = stub_generator.generate_tokens()
|
||||
json_tokens = stub_generator.serialize(apiview)
|
|
@ -13,7 +13,7 @@ from ._metadata_map import MetadataMap
|
|||
|
||||
JSON_FIELDS = ["Name", "Version", "VersionString", "Navigation", "Tokens", "Diagnostics", "PackageName", "Language"]
|
||||
|
||||
HEADER_TEXT = "# Package is parsed using api-stub-generator(version:{0}), Python version: {1}".format(VERSION, platform.python_version())
|
||||
HEADER_TEXT = "# Package is parsed using apiview-stub-generator(version:{0}), Python version: {1}".format(VERSION, platform.python_version())
|
||||
TYPE_NAME_REGEX = re.compile(r"(~?[a-zA-Z\d._]+)")
|
||||
TYPE_OR_SEPARATOR = " or "
|
||||
|
||||
|
@ -28,7 +28,7 @@ class ApiView:
|
|||
|
||||
@classmethod
|
||||
def get_root_path(cls):
|
||||
""" Looks for the root of the api-stub-generator package.
|
||||
""" Looks for the root of the apiview-stub-generator package.
|
||||
"""
|
||||
path = os.path.abspath(os.path.join(os.path.dirname(__file__)))
|
||||
while os.path.split(path)[1]:
|
|
@ -8,7 +8,7 @@ trigger:
|
|||
- hotfix/*
|
||||
paths:
|
||||
include:
|
||||
- packages/python-packages/api-stub-generator
|
||||
- packages/python-packages/apiview-stub-generator
|
||||
|
||||
pr:
|
||||
branches:
|
||||
|
@ -19,13 +19,13 @@ pr:
|
|||
- hotfix/*
|
||||
paths:
|
||||
include:
|
||||
- packages/python-packages/api-stub-generator
|
||||
- packages/python-packages/apiview-stub-generator
|
||||
|
||||
extends:
|
||||
template: /eng/pipelines/templates/stages/archetype-sdk-tool-python.yml
|
||||
parameters:
|
||||
PythonVersion: '3.10'
|
||||
PackagePath: 'packages/python-packages/api-stub-generator'
|
||||
PackagePath: 'packages/python-packages/apiview-stub-generator'
|
||||
FeedName: 'public/azure-sdk-for-python'
|
||||
ArtifactName: 'apiviewparserpython'
|
||||
PackageName: 'Python API View Parser'
|
||||
|
@ -35,7 +35,7 @@ extends:
|
|||
displayName: 'Verify Python APIView version consistency'
|
||||
|
||||
- script: |
|
||||
cd $(Build.SourcesDirectory)/packages/python-packages/api-stub-generator
|
||||
cd $(Build.SourcesDirectory)/packages/python-packages/apiview-stub-generator
|
||||
python -m pip install tox
|
||||
tox -e pytest,stubgen
|
||||
displayName: Run APIView tests
|
|
@ -1,7 +1,7 @@
|
|||
from setuptools import setup, find_packages
|
||||
import os, re
|
||||
|
||||
PACKAGE_NAME = "api-stub-generator"
|
||||
PACKAGE_NAME = "apiview-stub-generator"
|
||||
|
||||
DESCRIPTION = (
|
||||
"A stub generator for published APIs, variables and properties in a package"
|
|
@ -7,7 +7,7 @@
|
|||
<UserSecretsId>79cceff6-d533-4370-a0ee-f3321a343907</UserSecretsId>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
<JavaProcessor>..\..\..\java\apiview-java-processor\target\apiview-java-processor-1.28.0.jar</JavaProcessor>
|
||||
<PythonProcessor>..\..\..\..\packages\python-packages\api-stub-generator\dist\api_stub_generator-0.1.0-py3-none-any.whl</PythonProcessor>
|
||||
<PythonProcessor>..\..\..\..\packages\python-packages\apiview-stub-generator\dist\api_stub_generator-0.1.0-py3-none-any.whl</PythonProcessor>
|
||||
<GoProcessor>..\..\..\go\apiviewgo.exe</GoProcessor>
|
||||
<JavaScriptProcessor>..\..\..\..\tools\apiview\parsers\js-api-parser\</JavaScriptProcessor>
|
||||
<TypeScriptToolsVersion>latest</TypeScriptToolsVersion>
|
||||
|
|
|
@ -25,7 +25,7 @@ Core of the APIView tool is the web app developed using ASP.Net and TypeScript.
|
|||
| C++ | https://github.com/Azure/azure-sdk-tools/blob/main/src/dotnet/APIView/APIViewWeb/Languages/CppLanguageService.cs |
|
||||
| Java | https://github.com/Azure/azure-sdk-tools/tree/main/src/java/apiview-java-processor |
|
||||
| JS/TS | https://github.com/Azure/azure-sdk-tools/tree/main/tools/apiview/parsers/js-api-parser |
|
||||
| Python | https://github.com/Azure/azure-sdk-tools/tree/main/packages/python-packages/api-stub-generator |
|
||||
| Python | https://github.com/Azure/azure-sdk-tools/tree/main/packages/python-packages/apiview-stub-generator |
|
||||
| Go | https://github.com/Azure/azure-sdk-tools/tree/main/src/go |
|
||||
| Swift | https://github.com/Azure/azure-sdk-tools/tree/main/src/swift |
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче