| Name | kr8s JSON |
| Version |
0.14.4
JSON |
| download |
| home_page | None |
| Summary | A Kubernetes API library |
| upload_time | 2024-04-30 09:47:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD-3-Clause |
| keywords |
kubectl
kubernetes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div style="text-align: center; width: 100%;"><img src="branding/logo-wide.png" style="max-height: 200px;" /></div>
[](https://github.com/kr8s-org/kr8s/actions/workflows/test.yaml)
[](https://app.codecov.io/gh/kr8s-org/kr8s)
[](https://results.pre-commit.ci/latest/github/kr8s-org/kr8s/main)
[](https://docs.kr8s.org/en/stable/)
[](https://jacobtomlinson.dev/effver)
[](https://pypi.org/project/kr8s/)
[](https://pypi.org/project/kr8s/)
[](https://docs.kr8s.org/en/stable/installation.html#supported-kubernetes-versions)
[](https://pypi.org/project/kr8s/)
[](https://pypi.org/project/kr8s/)
A simple, extensible Python client library for Kubernetes that feels familiar for folks who already know how to use `kubectl`.
## Highlights
- API inspired by `kubectl` for a shallow learning curve.
- [Sensible defaults](https://docs.kr8s.org/en/stable/authentication.html) to reduce boiler plate.
- No swagger generated code, human readable code only.
- Has both a standard and an [async API](https://docs.kr8s.org/en/stable/asyncio.html) that can be used with `asyncio` and `trio`.
- [Client caching](https://docs.kr8s.org/en/stable/client.html#client-caching) to reduce passing API objects around.
- Batteries included by providing [useful utilities and methods](https://docs.kr8s.org/en/stable/examples/pod_operations.html) inspired by `kubectl`.
## Quickstart
### Installation
```console
$ pip install kr8s
```
## Examples
> [!TIP]
> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.
### List Nodes
Print out all of the node names in the cluster.
```python
import kr8s
for node in kr8s.get("nodes"):
print(node.name)
```
### Create a Pod
Create a new Pod.
```python
from kr8s.objects import Pod
pod = Pod({
"apiVersion": "v1",
"kind": "Pod",
"metadata": {
"name": "my-pod",
},
"spec": {
"containers": [{"name": "pause", "image": "gcr.io/google_containers/pause",}]
},
})
pod.create()
```
### Scale a Deployment
Scale the Deployment `metrics-server` in the Namespace `kube-system` to `1` replica.
```python
from kr8s.objects import Deployment
deploy = Deployment.get("metrics-server", namespace="kube-system")
deploy.scale(1)
```
### List Pods by label selector
Get all Pods from all Namespaces matching a label selector.
```python
import kr8s
selector = {'component': 'kube-scheduler'}
for pod in kr8s.get("pods", namespace=kr8s.ALL, label_selector=selector):
print(pod.namespace, pod.name)
```
### Add a label to a Pod
Add the label `foo` with the value `bar` to an existing Pod.
```python
from kr8s.objects import Pod
pod = Pod("kube-apiserver", namespace="kube-system")
pod.label({"foo": "bar"})
```
### Generate a Pod
Generate a simple Pod with a couple of keyword arguments.
```python
from kr8s.objects import Pod
pod = Pod.gen(name="example-1", image="nginx:latest")
pod.create()
```
### Cordon a Node
Cordon a Node to mark it as unschedulable.
```python
from kr8s.objects import Node
node = Node("k8s-node-1")
node.cordon()
```
### Pod Exec
Exec a command in a Pod.
```python
from kr8s.objects import Pod
pod = Pod.get("my-pod")
command = pod.exec(["uptime"])
print(command.stdout.decode())
# 13:49:05 up 23:03, 0 users, load average: 0.66, 0.87, 0.85
```
### Port forward a Pod
Open a port forward to a Pod as a background task/thread.
```python
from kr8s.objects import Pod
pod = Pod.get("my-pod")
pf = pod.portforward(remote_port=1234, local_port=5678)
# Starts the port forward in a background thread
pf.start()
# Your other code goes here
# Optionally stop the port forward thread (it will exit with Python anyway)
pf.stop()
```
> [!TIP]
> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.
Raw data
{
"_id": null,
"home_page": null,
"name": "kr8s",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "kubectl, kubernetes",
"author": null,
"author_email": "Jacob Tomlimson <jacob@tomlinson.email>",
"download_url": "https://files.pythonhosted.org/packages/62/0e/298fca0a3404f53829309c4caf7bde1d9485d8f3cd539a22d41deab52e14/kr8s-0.14.4.tar.gz",
"platform": null,
"description": "<div style=\"text-align: center; width: 100%;\"><img src=\"branding/logo-wide.png\" style=\"max-height: 200px;\" /></div>\n\n[](https://github.com/kr8s-org/kr8s/actions/workflows/test.yaml)\n[](https://app.codecov.io/gh/kr8s-org/kr8s)\n[](https://results.pre-commit.ci/latest/github/kr8s-org/kr8s/main)\n[](https://docs.kr8s.org/en/stable/)\n[](https://jacobtomlinson.dev/effver)\n[](https://pypi.org/project/kr8s/)\n[](https://pypi.org/project/kr8s/)\n[](https://docs.kr8s.org/en/stable/installation.html#supported-kubernetes-versions)\n[](https://pypi.org/project/kr8s/)\n[](https://pypi.org/project/kr8s/)\n\nA simple, extensible Python client library for Kubernetes that feels familiar for folks who already know how to use `kubectl`.\n\n## Highlights\n\n- API inspired by `kubectl` for a shallow learning curve.\n- [Sensible defaults](https://docs.kr8s.org/en/stable/authentication.html) to reduce boiler plate.\n- No swagger generated code, human readable code only.\n- Has both a standard and an [async API](https://docs.kr8s.org/en/stable/asyncio.html) that can be used with `asyncio` and `trio`.\n- [Client caching](https://docs.kr8s.org/en/stable/client.html#client-caching) to reduce passing API objects around.\n- Batteries included by providing [useful utilities and methods](https://docs.kr8s.org/en/stable/examples/pod_operations.html) inspired by `kubectl`.\n\n## Quickstart\n\n### Installation\n\n```console\n$ pip install kr8s\n```\n\n## Examples\n\n> [!TIP]\n> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.\n\n### List Nodes\n\nPrint out all of the node names in the cluster.\n\n```python\nimport kr8s\n\nfor node in kr8s.get(\"nodes\"):\n print(node.name)\n```\n\n### Create a Pod\n\nCreate a new Pod.\n\n```python\nfrom kr8s.objects import Pod\n\npod = Pod({\n \"apiVersion\": \"v1\",\n \"kind\": \"Pod\",\n \"metadata\": {\n \"name\": \"my-pod\",\n },\n \"spec\": {\n \"containers\": [{\"name\": \"pause\", \"image\": \"gcr.io/google_containers/pause\",}]\n },\n })\n\npod.create()\n```\n\n### Scale a Deployment\n\nScale the Deployment `metrics-server` in the Namespace `kube-system` to `1` replica.\n\n```python\nfrom kr8s.objects import Deployment\n\ndeploy = Deployment.get(\"metrics-server\", namespace=\"kube-system\")\ndeploy.scale(1)\n```\n\n### List Pods by label selector\n\nGet all Pods from all Namespaces matching a label selector.\n\n```python\nimport kr8s\n\nselector = {'component': 'kube-scheduler'}\n\nfor pod in kr8s.get(\"pods\", namespace=kr8s.ALL, label_selector=selector):\n print(pod.namespace, pod.name)\n```\n\n### Add a label to a Pod\n\nAdd the label `foo` with the value `bar` to an existing Pod.\n\n```python\nfrom kr8s.objects import Pod\n\npod = Pod(\"kube-apiserver\", namespace=\"kube-system\")\npod.label({\"foo\": \"bar\"})\n```\n\n### Generate a Pod\n\nGenerate a simple Pod with a couple of keyword arguments.\n\n```python\nfrom kr8s.objects import Pod\n\npod = Pod.gen(name=\"example-1\", image=\"nginx:latest\")\npod.create()\n```\n\n### Cordon a Node\n\nCordon a Node to mark it as unschedulable.\n\n```python\nfrom kr8s.objects import Node\n\nnode = Node(\"k8s-node-1\")\n\nnode.cordon()\n```\n\n### Pod Exec\n\nExec a command in a Pod.\n\n```python\nfrom kr8s.objects import Pod\n\npod = Pod.get(\"my-pod\")\n\ncommand = pod.exec([\"uptime\"])\nprint(command.stdout.decode())\n# 13:49:05 up 23:03, 0 users, load average: 0.66, 0.87, 0.85\n```\n\n### Port forward a Pod\n\nOpen a port forward to a Pod as a background task/thread.\n\n```python\nfrom kr8s.objects import Pod\n\npod = Pod.get(\"my-pod\")\npf = pod.portforward(remote_port=1234, local_port=5678)\n\n# Starts the port forward in a background thread\npf.start()\n\n# Your other code goes here\n\n# Optionally stop the port forward thread (it will exit with Python anyway)\npf.stop()\n```\n\n> [!TIP]\n> See the [Examples Documentation](https://docs.kr8s.org/en/stable/examples/) for a full set of examples including `asyncio` examples.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A Kubernetes API library",
"version": "0.14.4",
"project_urls": {
"Changelog": "https://github.com/kr8s-org/kr8s/releases",
"Documentation": "https://docs.kr8s.org/en/stable",
"Issues": "https://github.com/kr8s-org/kr8s/issues",
"Repository": "https://github.com/kr8s-org/kr8s.git"
},
"split_keywords": [
"kubectl",
" kubernetes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da59773f7937ca42bf0a8dcdb935c223c44a081f04bb4e159d1501ae9b152b31",
"md5": "b25245c7b3430d6b8f27858caac0feda",
"sha256": "440d31a00da1ed5e59b3e9812eb7404022400417ab4aa575abf1c8d3a6fbab53"
},
"downloads": -1,
"filename": "kr8s-0.14.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b25245c7b3430d6b8f27858caac0feda",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 60715,
"upload_time": "2024-04-30T09:47:46",
"upload_time_iso_8601": "2024-04-30T09:47:46.977642Z",
"url": "https://files.pythonhosted.org/packages/da/59/773f7937ca42bf0a8dcdb935c223c44a081f04bb4e159d1501ae9b152b31/kr8s-0.14.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "620e298fca0a3404f53829309c4caf7bde1d9485d8f3cd539a22d41deab52e14",
"md5": "b75ae78083ac76de580cb95ae62b25c8",
"sha256": "d96fc937a14116511234c797ba92459bc691f7295acfc01ff84763e3f3aea094"
},
"downloads": -1,
"filename": "kr8s-0.14.4.tar.gz",
"has_sig": false,
"md5_digest": "b75ae78083ac76de580cb95ae62b25c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2837479,
"upload_time": "2024-04-30T09:47:48",
"upload_time_iso_8601": "2024-04-30T09:47:48.859479Z",
"url": "https://files.pythonhosted.org/packages/62/0e/298fca0a3404f53829309c4caf7bde1d9485d8f3cd539a22d41deab52e14/kr8s-0.14.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 09:47:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kr8s-org",
"github_project": "kr8s",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kr8s"
}
