Pre-release

This release is a pre-release and may not be stable for production use.

pyhelm3

Python library for managing Helm releases using Helm 3 and later (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, # when using a helm 3 client, rollback_on_failure=True when using a helm 4 client
    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)

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.5.4)

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for johngarbutt from gravatar.com johngarbutt Avatar for mkjpryor from gravatar.com mkjpryor Avatar for sd109 from gravatar.com sd109
+1 more Avatar for stackhpc_willt from gravatar.com stackhpc_willt

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Report project as malware

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.4rc1.tar.gz (20.3 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.4rc1-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file pyhelm3-0.5.4rc1.tar.gz.

File metadata

  • Download URL: pyhelm3-0.5.4rc1.tar.gz
  • Upload date:
  • Size: 20.3 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.4rc1.tar.gz
Algorithm Hash digest
SHA256 80d0e449bcf3986520d9eabebfbabf9f5b3ec6f2221067f0cb88823be925176f
MD5 3a51d78727510fdec320614215adadaa
BLAKE2b-256 812ea054ee9b01099647cde3da63bc0182837d3808fedc65b013044cc3f4437e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhelm3-0.5.4rc1.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.4rc1-py3-none-any.whl.

File metadata

  • Download URL: pyhelm3-0.5.4rc1-py3-none-any.whl
  • Upload date:
  • Size: 21.9 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.4rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b9cf04ccb2b5d65b6a422cc18ce051683ce11a5c41fbbba6eb94c08792a783a
MD5 77bb6da7a72282176e2f7691f59d01ee
BLAKE2b-256 ba53d886b4fe031190d573eb1dc9b7dda66a14881c30c0d2d9ddec23252dd391

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyhelm3-0.5.4rc1-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