Skip to main content

pyhelm3

Python library for managing Helm releases using Helm 3 (i.e. Tiller-less Helm).

Installation

pyhelm3 can be installed from PyPI:

pip install pyhelm3

Usage

from pyhelm3 import Client


# This will use the Kubernetes configuration from the environment
client = Client()
# Specify the kubeconfig file to use
client = Client(kubeconfig = "/path/to/kubeconfig")
# Specify the kubecontext to use
client = Client(kubecontext = "kubecontext")
# Specify a custom Helm executable (by default, we expect 'helm' to be on the PATH)
client = Client(executable = "/path/to/helm")


# List the deployed releases
releases = await client.list_releases(all = True, all_namespaces = True)
for release in releases:
    revision = await release.current_revision()
    print(release.name, release.namespace, revision.revision, str(revision.status))


# Get the current revision for an existing release
revision = await client.get_current_revision("cert-manager", namespace = "cert-manager")
chart_metadata = await revision.chart_metadata()
print(
    revision.release.name,
    revision.release.namespace,
    revision.revision,
    str(revision.status),
    chart_metadata.name,
    chart_metadata.version
)


# Fetch a chart
chart = await client.get_chart(
    "cert-manager",
    repo = "https://charts.jetstack.io",
    version = "v1.8.x"
)
print(chart.metadata.name, chart.metadata.version)
print(await chart.readme())


# Install or upgrade a release
revision = await client.install_or_upgrade_release(
    "cert-manager",
    chart,
    { "installCRDs": True },
    atomic = True,
    wait = True
)
print(
    revision.release.name,
    revision.release.namespace,
    revision.revision,
    str(revision.status)
)


# Uninstall a release
#   Via the revision
revision = await client.get_current_revision("cert-manager", namespace = "cert-manager")
await revision.release.uninstall(wait = True)
#   Or directly by name
await client.uninstall_release("cert-manager", namespace = "cert-manager", wait = True)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhelm3-0.5.0.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhelm3-0.5.0-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file pyhelm3-0.5.0.tar.gz.

File metadata

  • Download URL: pyhelm3-0.5.0.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyhelm3-0.5.0.tar.gz
Algorithm Hash digest
SHA256 33631636b79e23b709cf9f584c43cffbb0fe8b8de1a7ac463ca01703d75eab5d
MD5 112d16967b602f583cf2d58fb405765d
BLAKE2b-256 1c0f5977b4f8f005edd3cd5b16b80d84ebfe47281e89293150d988b3341436d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhelm3-0.5.0.tar.gz:

Publisher: pypi-publish.yaml on azimuth-cloud/pyhelm3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyhelm3-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: pyhelm3-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyhelm3-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c69a009180d446dfb2c7dd77458fe0926202b762d58f498a8a133ddc019fa89
MD5 e906e6dfcc5915643b6ad8dbff8d107e
BLAKE2b-256 b0ad76a48d31a02d4d2aa6574b82380b7b2365ef4bc35b098672921372cbc619

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhelm3-0.5.0-py3-none-any.whl:

Publisher: pypi-publish.yaml on azimuth-cloud/pyhelm3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page