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

This version

0.8.3

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.3.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

kr8s-0.8.3-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.3.tar.gz
  • Upload date:
  • Size: 29.9 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.3.tar.gz
Algorithm Hash digest
SHA256 682babc21794d2400089873b0761edc30d5c9e84ba721bcd05cf632e21da1f20
MD5 227bd70bfa103707062225b3de7f9c37
BLAKE2b-256 c174e02bd87187863be61dada5f3a13e6ba6e5b0586025326e33b128af05769b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 37.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1a7d34a0b02c70a90f11c0e949a1d8ebf273ca7c302da08b4a40b7e229e275bb
MD5 f0b5d1d942fe6ddd49111419044afbba
BLAKE2b-256 c226e215ea5044542371e4225f1cc11d6a8c846cb2f603ce078fbaf239cf0532

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