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.0

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

Uploaded Source

Built Distribution

kr8s-0.8.0-py3-none-any.whl (37.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kr8s-0.8.0.tar.gz
Algorithm Hash digest
SHA256 464bf9725d6474522ea2f538cd2100e8e81a3f17e00767b48951fc5579a2ec61
MD5 a2f5d86311a5708e0f6608ce8e182109
BLAKE2b-256 f4886b89dda724a6fde6e57695030298dceff67416fa6a7fd86cfb1442c048e1

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for kr8s-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33052f676d0446ccc1cc840b1db092244ffe57840b7f9cf7f37694d3778808db
MD5 534b4553b12996cb6d9267a8ac2e691b
BLAKE2b-256 a63d4f38308036ac66c31b3b9b2b7c5e30781752eff226e9e3fbdeec2dcd4bea

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