kubernetes-client/python — a developer tool — sits at 7.7k GitHub stars in the Developer Tools space. Official Python client library for kubernetes
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
from kubernetes import client, config
# Configs can be set in Configuration class directly or using helper utility
config.load_kube_config()
v1 = client.CoreV1Api()
print("Listing pods with their IPs:")
ret = v1.list_pod_for_all_namespaces(watch=False)
for i in ret.items:
print("%s\t%s\t%s" % (i.status.pod_ip, i.metadata.namespace, i.metadata.name))
list all pods using asyncio:
import asyncio
from kubernetes.aio import client, config
from kubernetes.aio.client.api_client import ApiClient
async def main():
# Configs can be set in Configuration class directly or using helper
# utility. If no argument provided, the config will be loaded from
# default location.
await config.load_kube_config()
# use the context manager to close http sessions automatically
async with ApiClient() as api:
v1 = client.CoreV1Api(api)
print("Listing pods with their IPs:")
ret = await v1.list_pod_for_all_namespaces()
for i in ret.items:
print(i.status.pod_ip, i.metadata.namespace, i.metadata.name)
if __name__ == '__main__':
asyncio.run(main())
watch on namespace object:
from kubernetes import client, config, watch
# Configs can be set in Configuration class directly or using helper utility
config.load_kube_config()
v1 = client.CoreV1Api()
count = 10
w = watch.Watch()
for event in w.stream(v1.list_namespace, _request_timeout=60):
print("Event: %s %s" % (event['type'], event['object'].metadata.name))
count -= 1
if not count:
w.stop()
print("Ended.")
More examples can be found in examples folder. To run examples, run this command:
python -m examples.example1
(replace example1 with one of the filenames in the examples folder)
Documentation
All APIs and Models' documentation can be found at the Generated client's README file
Compatibility
client-python follows semver, so until the major version of
client-python gets increased, your code will continue to work with explicitly
supported versions of Kubernetes clusters.
Compatibility matrix of supported client versions
client 9.y.z: Kubernetes 1.12 or below (+-), Kubernetes 1.13 (✓), Kubernetes 1.14 or above (+-)
client 10.y.z: Kubernetes 1.13 or below (+-), Kubernetes 1.14 (✓), Kubernetes 1.14 or above (+-)
client 11.y.z: Kubernetes 1.14 or below (+-), Kubernetes 1.15 (✓), Kubernetes 1.16 or above (+-)
client 12.y.z: Kubernetes 1.15 or below (+-), Kubernetes 1.16 (✓), Kubernetes 1.17 or above (+-)
client 17.y.z: Kubernetes 1.16 or below (+-), Kubernetes 1.17 (✓), Kubernetes 1.18 or above (+-)
client 18.y.z: Kubernetes 1.17 or below (+-), Kubernetes 1.18 (✓), Kubernetes 1.19 or above (+-)
client 19.y.z: Kubernetes 1.18 or below (+-), Kubernetes 1.19 (✓), Kubernetes 1.20 or above (+-)
client 20.y.z: Kubernetes 1.19 or below (+-), Kubernetes 1.20 (✓), Kubernetes 1.21 or above (+-)
client 21.y.z: Kubernetes 1.20 or below (+-), Kubernetes 1.21 (✓), Kubernetes 1.22 or above (+-)
client 22.y.z: Kubernetes 1.21 or below (+-), Kubernetes 1.22 (✓), Kubernetes 1.23 or above (+-)
client 23.y.z: Kubernetes 1.22 or below (+-), Kubernetes 1.23 (✓), Kubernetes 1.24 or above (+-)
client 24.y.z: Kubernetes 1.23 or below (+-), Kubernetes 1.24 (✓), Kubernetes 1.25 or above (+-)
client 25.y.z: Kubernetes 1.24 or below (+-), Kubernetes 1.25 (✓), Kubernetes 1.26 or above (+-)
client 26.y.z: Kubernetes 1.25 or below (+-), Kubernetes 1.26 (✓), Kubernetes 1.27 or above (+-)
client 27.y.z: Kubernetes 1.26 or below (+-), Kubernetes 1.27 (✓), Kubernetes 1.28 or above (+-)
client 28.y.z: Kubernetes 1.27 or below (+-), Kubernetes 1.28 (✓), Kubernetes 1.29 or above (+-)
client 29.y.z: Kubernetes 1.28 or below (+-), Kubernetes 1.29 (✓), Kubernetes 1.30 or above (+-)
client 30.y.z: Kubernetes 1.29 or below (+-), Kubernetes 1.30 (✓), Kubernetes 1.31 or above (+-)
client 31.y.z: Kubernetes 1.30 or below (+-), Kubernetes 1.31 (✓), Kubernetes 1.32 or above (+-)
client 32.y.z: Kubernetes 1.31 or below (+-), Kubernetes 1.32 (✓), Kubernetes 1.33 or above (+-)
client 33.y.z: Kubernetes 1.32 or below (+-), Kubernetes 1.33 (✓), Kubernetes 1.34 or above (+-)
client 34.y.z: Kubernetes 1.33 or below (+-), Kubernetes 1.34 (✓), Kubernetes 1.35 or above (+-)
client 35.y.z: Kubernetes 1.34 or below (+-), Kubernetes 1.35 (✓), Kubernetes 1.36 or above (+-)
client 36.y.z: Kubernetes 1.35 or below (+-), Kubernetes 1.36 (✓), Kubernetes 1.37 or above (+-)
client 37.y.z: Kubernetes 1.36 or below (+-), Kubernetes 1.37 (✓), Kubernetes 1.38 or above (+-)
See here for an explanation of why there is no v13-v16 release.
Key:
✓ Exactly the same features / API objects in both client-python and the Kubernetes
version.
+ client-python has features or API objects that may not be present in the Kubernetes
cluster, either due to that client-python has additional new API, or that the server has
removed old API. However, everything they have in common (i.e., most APIs) will work.
Please note that alpha APIs may vanish or change significantly in a single release.
- The Kubernetes cluster has features the client-python library can't use, either due
to the server has additional new API, or that client-python has removed old API. However,
everything they share in common (i.e., most APIs) will work.
See the CHANGELOG for a detailed description of changes
between client-python versions.
Client version
Canonical source for OpenAPI spec
Maintenance status
5.0 Alpha/Beta
Kubernetes main repo, 1.9 branch
✗
5.0
Kubernetes main repo, 1.9 branch
✗
6.0 Alpha/Beta
Kubernetes main repo, 1.10 branch
✗
6.0
Kubernetes main repo, 1.10 branch
✗
7.0 Alpha/Beta
Kubernetes main repo, 1.11 branch
✗
7.0
Kubernetes main repo, 1.11 branch
✗
8.0 Alpha/Beta
Kubernetes main repo, 1.12 branch
✗
8.0
Kubernetes main repo, 1.12 branch
✗
9.0 Alpha/Beta
Kubernetes main repo, 1.13 branch
✗
9.0
Kubernetes main repo, 1.13 branch
✗
10.0 Alpha/Beta
Kubernetes main repo, 1.14 branch
✗
10.0
Kubernetes main repo, 1.14 branch
✗
11.0 Alpha/Beta
Kubernetes main repo, 1.15 branch
✗
11.0
Kubernetes main repo, 1.15 branch
✗
12.0 Alpha/Beta
Kubernetes main repo, 1.16 branch
✗
12.0
Kubernetes main repo, 1.16 branch
✗
17.0 Alpha/Beta
Kubernetes main repo, 1.17 branch
✗
17.0
Kubernetes main repo, 1.17 branch
✗
18.0 Alpha/Beta
Kubernetes main repo, 1.18 branch
✗
18.0
Kubernetes main repo, 1.18 branch
✗
19.0 Alpha/Beta
Kubernetes main repo, 1.19 branch
✗
19.0
Kubernetes main repo, 1.19 branch
✗
20.0 Alpha/Beta
Kubernetes main repo, 1.20 branch
✗
20.0
Kubernetes main repo, 1.20 branch
✗
21.0 Alpha/Beta
Kubernetes main repo, 1.21 branch
✗
21.0
Kubernetes main repo, 1.21 branch
✗
22.0 Alpha/Beta
Kubernetes main repo, 1.22 branch
✗
22.0
Kubernetes main repo, 1.22 branch
✗
23.0 Alpha/Beta
Kubernetes main repo, 1.23 branch
✗
23.0
Kubernetes main repo, 1.23 branch
✗
24.0 Alpha/Beta
Kubernetes main repo, 1.24 branch
✗
24.0
Kubernetes main repo, 1.24 branch
✗
25.0 Alpha/Beta
Kubernetes main repo, 1.25 branch
✗
25.0
Kubernetes main repo, 1.25 branch
✗
26.0 Alpha/Beta
Kubernetes main repo, 1.26 branch
✗
26.0
Kubernetes main repo, 1.26 branch
✗
27.0 Alpha/Beta
Kubernetes main repo, 1.27 branch
✗
27.0
Kubernetes main repo, 1.27 branch
✗
28.0 Alpha/Beta
Kubernetes main repo, 1.28 branch
✗
28.0
Kubernetes main repo, 1.28 branch
✗
29.0 Alpha/Beta
Kubernetes main repo, 1.29 branch
✗
29.0
Kubernetes main repo, 1.29 branch
✗
30.0 Alpha/Beta
Kubernetes main repo, 1.30 branch
✗
30.0
Kubernetes main repo, 1.30 branch
✗
31.0 Alpha/Beta
Kubernetes main repo, 1.31 branch
✗
31.0
Kubernetes main repo, 1.31 branch
✗
32.0 Alpha/Beta
Kubernetes main repo, 1.32 branch
✗
32.1
Kubernetes main repo, 1.32 branch
✗
33.1 Alpha/Beta
Kubernetes main repo, 1.33 branch
✗
33.1
Kubernetes main repo, 1.33 branch
✗
34.1 Alpha/Beta
Kubernetes main repo, 1.34 branch
✗
34.1
Kubernetes main repo, 1.34 branch
✗
35.0 Alpha/Beta
Kubernetes main repo, 1.35 branch
✗
35.0
Kubernetes main repo, 1.35 branch
✓
36.0 Alpha/Beta
Kubernetes main repo, 1.36 branch
✗
36.0
Kubernetes main repo, 1.36 branch
✓
37.0 Alpha/Beta
Kubernetes main repo, 1.37 branch
✗
37.0
Kubernetes main repo, 1.37 branch
✓
See here for an explanation of why there is no v13-v16 release.
Key:
✓ Changes in main Kubernetes repo are manually (should be automated) published to client-python when they are available.
✗ No longer maintained; please upgrade.
Kubernetes supports three minor releases at a time. "Support" means we expect users to be running that version in production, though we may not port fixes back before the latest minor version. For example, when v1.3 comes out, v1.0 will no longer be supported. In consistent with Kubernetes support policy, we expect to support three GA major releases (corresponding to three Kubernetes minor releases) at a time.
Note: There would be no maintenance for alpha/beta releases except the latest one.
Exception to the above support rule: Since we are running behind on releases, we will support Alpha/Beta releases for a greater number of clients until we catch up with the upstream version.
Homogenizing the Kubernetes Python Client versions
The client releases v12 and before following a versioning schema where the major version was 4 integer positions behind the Kubernetes minor on which the client is based on. For example, v12.0.0 is based on Kubernetes v1.16, v11.0.0 is based on Kubernetes v1.15 and so on.
This created a lot of confusion tracking two different version numbers for each client release. It was decided to homogenize the version scheme starting from the Kubernetes Python client based on Kubernetes v1.17. The versioning scheme of the client from this release would be vY.Z.P where Y and Z are the Kubernetes minor and patch release numbers from Kubernetes v1.Y.Z and P is the client specific patch release numbers to accommodate changes and fixes done specifically to the client. For more details, refer this issue.
Community, Support, Discussion
If you have any problem on using the package or any suggestions, please start with reaching the Kubernetes clients slack channel, or filing an issue to let us know. You can also reach the maintainers of this project at SIG API Machinery, where this project falls under.
Code of Conduct
Participation in the Kubernetes community is governed by the CNCF Code of Conduct.
Troubleshooting
SSLError on macOS
If you get an SSLError, you likely need to update your version of python. The
version that ships with macOS may not be supported.
Install the latest version of python with brew:
brew install python
Once installed, you can query the version of OpenSSL like so:
You'll need a version with OpenSSL version 1.0.0 or later.
Hostname doesn't match
If you get an ssl.CertificateError complaining about hostname match, your installed packages does not meet version requirements.
Specifically check ipaddress and urllib3 package versions to make sure they met requirements in requirements.txt file.
Why Exec/Attach calls doesn't work
Starting from 4.0 release, we do not support directly calling exec or attach calls. you should use stream module to call them. so instead
of resp = api.connect_get_namespaced_pod_exec(name, ... you should call resp = stream(api.connect_get_namespaced_pod_exec, name, ....
Using Stream will overwrite the requests protocol in core_v1_api.CoreV1Api()
This will cause a failure in non-exec/attach calls. If you reuse your api client object, you will need to
recreate it between api calls that use stream and other api calls.
See more at exec example.
Enabling Debug Logging
To enable debug logging in the Kubernetes Python client, follow these steps:
1. Import the logging module
import logging
# Set the logging level to DEBUG
logging.basicConfig(level=logging.DEBUG)
# To see the HTTP requests and responses sent to the Kubernetes API (for debugging network-related issues), configure the urllib3 logger:
logging.getLogger("urllib3").setLevel(logging.DEBUG)
How active is development on kubernetes-client/python?
The most recent commit recorded on kubernetes-client/python was 3 months ago, based on the GitHub push timestamp. The repository has 3.5k forks — one of the better signals of community interest.
How many stars does kubernetes-client/python have?
kubernetes-client/python has 7.7k GitHub stars — refresh the page for the live number, or check github.com/kubernetes-client/python. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What else is in the Developer Tools space?
kubernetes-client/python is tracked by TopGit under the Developer Tools category, alongside 5 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What language is kubernetes-client/python written in?
kubernetes-client/python is written primarily in Python. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is kubernetes-client/python associated with?
GitHub's repository topics for kubernetes-client/python: "client-python", "k8s", "k8s-sig-api-machinery", "kubernetes", "library". TopGit's editorial category is Developer Tools.
Where do I read more about kubernetes-client/python?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/kubernetes-client/python is the definitive source.
Why is kubernetes-client/python categorized under Developer Tools?
TopGit places kubernetes-client/python in the Developer Tools category based on its GitHub topics and description (tagged: "client-python", "k8s", "k8s-sig-api-machinery"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Curious whether python is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about python.