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)
4 maintainers
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.1.tar.gz
(19.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
pyhelm3-0.5.1-py3-none-any.whl
(21.7 kB
view details)
File details
Details for the file pyhelm3-0.5.1.tar.gz.
File metadata
- Download URL: pyhelm3-0.5.1.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84c3296c27aaafdfa7e17dec2c909757f759ebe9c73c4fd42f1538d4333cc803
|
|
| MD5 |
5e6430a494ecb2a4a945f35c24f3ee70
|
|
| BLAKE2b-256 |
95041ddb36f6a8294994f61964823ed871c5a39195c8c3eaa15cf986e1aef61c
|
Provenance
The following attestation bundles were made for pyhelm3-0.5.1.tar.gz:
Publisher:
pypi-publish.yaml on azimuth-cloud/pyhelm3
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyhelm3-0.5.1.tar.gz -
Subject digest:
84c3296c27aaafdfa7e17dec2c909757f759ebe9c73c4fd42f1538d4333cc803 - Sigstore transparency entry: 2224646472
- Sigstore integration time:
-
Permalink:
azimuth-cloud/pyhelm3@9431876afa9281e2a2e53a274e491c4dd64579de -
Branch / Tag:
refs/tags/0.5.1 - Owner: https://github.com/azimuth-cloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yaml@9431876afa9281e2a2e53a274e491c4dd64579de -
Trigger Event:
push
-
Statement type:
File details
Details for the file pyhelm3-0.5.1-py3-none-any.whl.
File metadata
- Download URL: pyhelm3-0.5.1-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c73cd19637233bbebe93f60a667917df295a5ca5cca26a4032395d33d830fabc
|
|
| MD5 |
897e1ab186babf8ddbc75aa2f13c18f7
|
|
| BLAKE2b-256 |
bb84a50ca17f6ba29c6a1e27e682f84e2dec25489aa87fb0875eb9a32b26d18e
|
Provenance
The following attestation bundles were made for pyhelm3-0.5.1-py3-none-any.whl:
Publisher:
pypi-publish.yaml on azimuth-cloud/pyhelm3
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyhelm3-0.5.1-py3-none-any.whl -
Subject digest:
c73cd19637233bbebe93f60a667917df295a5ca5cca26a4032395d33d830fabc - Sigstore transparency entry: 2224646784
- Sigstore integration time:
-
Permalink:
azimuth-cloud/pyhelm3@9431876afa9281e2a2e53a274e491c4dd64579de -
Branch / Tag:
refs/tags/0.5.1 - Owner: https://github.com/azimuth-cloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yaml@9431876afa9281e2a2e53a274e491c4dd64579de -
Trigger Event:
push
-
Statement type:
