Skip to main content

A Kubernetes API library

Project description

Test Codecov pre-commit.ci status Read the Docs PyPI PyPI - Python Version Kubernetes Version Support PyPI - Wheel PyPI - License

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 to reduce developer learning curve.
  • Sensible defaults to reduce boiler plate.
  • No swagger generated code, human readable code only.
  • Also has an asynchronous API that can be used with asyncio and trio.
  • Client caching to reduce passing API objects around.
  • Batteries included by providing useful utilities and methods inspired by kubectl.

Quickstart

Installation

$ pip install kr8s

Client API

import kr8s

pods = kr8s.get("pods")

See the Client API docs for more examples.

Object API

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()

See the Object API docs for more examples.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kr8s-0.8.13.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

kr8s-0.8.13-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

Details for the file kr8s-0.8.13.tar.gz.

File metadata

  • Download URL: kr8s-0.8.13.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.0 Linux/5.15.0-1041-azure

File hashes

Hashes for kr8s-0.8.13.tar.gz
Algorithm Hash digest
SHA256 708c77e480e754aadfdf366609ce89d6e8100085a15980f4f77fca8066f19397
MD5 2cadd0bc7c057826bc96463b804262ac
BLAKE2b-256 c8820a880be6f0d92dfc689abf1e9c305d106c4989e50037278b5d7df006a858

See more details on using hashes here.

Provenance

File details

Details for the file kr8s-0.8.13-py3-none-any.whl.

File metadata

  • Download URL: kr8s-0.8.13-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.0 Linux/5.15.0-1041-azure

File hashes

Hashes for kr8s-0.8.13-py3-none-any.whl
Algorithm Hash digest
SHA256 1d61d78fa0bee385e593e03d3444eccabdea53cde86cca4e5daf72621eba59c1
MD5 96f414e1730dbe0c0b299bfe27751f10
BLAKE2b-256 7e4260815d903d80d7bfa2d570282f7048abae96e4fd1cd6104110f0e56d088e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page