This file gives public, contributor-safe guidance for AI coding assistants.
ksadk-python contains the public Python SDK, CLI, runtime adapters, packaged
static UI output, and MkDocs documentation. Editable Web UI source is maintained
in https://github.com/kingsoftcloud/ksadk-web.
- Read nearby code and tests before changing behavior.
- Keep generated artifacts, credentials, local machine paths, private deployment files, and internal operational notes out of commits.
- Preserve Apache-2.0 licensing and public-facing links.
Use focused checks while iterating:
uv run --extra dev pytest tests/test_open_source_audit.py tests/test_runtime_common_packaging.py -q
uv run --extra dev python -m mkdocs build --strict
make open-source-auditFor release work, also run:
uv build
uv run --extra dev python -m twine check dist/*
make open-source-audit-distNever store or commit PyPI credentials, .pypirc, GitHub tokens, kubeconfig
files, private registry credentials, or real model provider API keys.