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.2.tar.gz
(20.0 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.2-py3-none-any.whl
(21.8 kB
view details)
File details
Details for the file pyhelm3-0.5.2.tar.gz.
File metadata
- Download URL: pyhelm3-0.5.2.tar.gz
- Upload date:
- Size: 20.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04e8cb1260d3a59f3773dc30f578e1563c157b89fc69f402ca764285aeecc849
|
|
| MD5 |
e83e3fa8285444c6d471dff046fa10fd
|
|
| BLAKE2b-256 |
1e0d8c1ec7da5af89ce384b92aab2ac3751092d6fc8d6d966f693e5acf412f05
|
Provenance
The following attestation bundles were made for pyhelm3-0.5.2.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.2.tar.gz -
Subject digest:
04e8cb1260d3a59f3773dc30f578e1563c157b89fc69f402ca764285aeecc849 - Sigstore transparency entry: 2235438475
- Sigstore integration time:
-
Permalink:
azimuth-cloud/pyhelm3@4c90737a2611e1648f0536426bd4a9a33ee1c170 -
Branch / Tag:
refs/tags/0.5.2 - Owner: https://github.com/azimuth-cloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yaml@4c90737a2611e1648f0536426bd4a9a33ee1c170 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pyhelm3-0.5.2-py3-none-any.whl.
File metadata
- Download URL: pyhelm3-0.5.2-py3-none-any.whl
- Upload date:
- Size: 21.8 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 |
16b7cbae588b77a07f4372bc10d6346d1c07a032d3a36896d8a855341b50d7a8
|
|
| MD5 |
bba93b2aaa841f626ac4ac4e0cb58b8d
|
|
| BLAKE2b-256 |
a3aa853a7588faf68efcdc6732fecc2c999f192757ad00f435a43743490876de
|
Provenance
The following attestation bundles were made for pyhelm3-0.5.2-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.2-py3-none-any.whl -
Subject digest:
16b7cbae588b77a07f4372bc10d6346d1c07a032d3a36896d8a855341b50d7a8 - Sigstore transparency entry: 2235438607
- Sigstore integration time:
-
Permalink:
azimuth-cloud/pyhelm3@4c90737a2611e1648f0536426bd4a9a33ee1c170 -
Branch / Tag:
refs/tags/0.5.2 - Owner: https://github.com/azimuth-cloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yaml@4c90737a2611e1648f0536426bd4a9a33ee1c170 -
Trigger Event:
push
-
Statement type:
