kserve/hack/python-sdk

Readme for Generating KServe SDK

The guide shows how to generate the openapi model and swagger.json file from KServe types using openapi-gen and generate Python SDK Client for the Python object models using openapi-codegen. Also show how to upload the Python SDK to Pypi.

Generate openapi spec and swagger file.

From root folder, you can make generate or execute the below script directly to generate openapi spec and swagger file.

./hack/update-openapigen.sh

After executing, the openapi_generated.go and swagger.json are generated and stored under pkg/apis/serving/v1beta1/.

Generate Python SDK

From root folder, execute the script /hack/python-sdk/client-gen.sh to install openapi-codegen and generate Python SDK.

./hack/python-sdk/client-gen.sh

After the script execution, the Python SDK is generated in the python/kserve directory. Some files such as README and documents need to be merged manually after the script execution.

(Optional) Refresh Python SDK in the Pypi

Navigate to python/kserve directory from the root folder.

1. Install UV:

   pip install uv
   

2. Update the Python SDK version in the pyproject.toml.

3. Create some distributions in the normal way:

   uv build
   

4. Publish with uv to Test PyPI and verify things look right:

   uv publish \
     --publish-url https://test.pypi.org/legacy/ \
     --token your_testpypi_api_token_here \
     dist/*