Skip to main content

Installation

Prerequisites​

  • Python 3.12 or higher
  • A Kubernetes cluster (for runtime operations)
  • kubectl configured (optional)

Install via pip​

pip install helm-sdkpy

Install via uv​

uv add helm-sdkpy

Verify Installation​

import asyncio
from helm_sdkpy import Configuration

async def main():
    config = Configuration(namespace="default")
    print("helm-sdkpy is installed and ready!")

asyncio.run(main())

Kubernetes Configuration​

helm-sdkpy uses your kubeconfig to connect to Kubernetes clusters. By default, it uses:

  1. The KUBECONFIG environment variable
  2. ~/.kube/config if no environment variable is set

You can also specify a custom kubeconfig path:

from helm_sdkpy import Configuration

config = Configuration(
    namespace="my-namespace",
    kubeconfig="/path/to/kubeconfig",
    kubecontext="my-context"
)

Development Installation​

For development, clone the repository and install with development dependencies:

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

Docker​

The project includes Docker support for building the native library. See Architecture for details.

Next Steps​