Skip to main content

Contributing

Short guide for working on Vantage SDKPy.

Environment Setup​

git clone https://github.com/vantagecompute/vantage-sdkpy.git
cd vantage-sdkpy
uv sync

Run tests:

uv run --with pytest pytest tests/test_sdk_smoke.py

Standards​

  • keep the SDK headless
  • avoid filesystem-backed behavior in the standalone package
  • return Python objects rather than rendered output
  • preserve compatibility for vantage-cli where practical

Docs Development​

cd docusaurus
yarn
yarn start

Generate API docs directly:

yarn generate-api-docs