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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.1.tar.gz
  • Upload date:
  • Size: 29.8 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.1.tar.gz
Algorithm Hash digest
SHA256 a9abf4695a2780886dcdb27f41e59243dc49276fa6a3d80245763a8a981f64a2
MD5 015e791450915e3a0dc1c3f790354888
BLAKE2b-256 f8951b906bc18fceb27b2dcac0869085b913e0635c633af7e7000e249670fb34

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 05f22782f53d6c3b8ea394ebefceb76e19097615a68e7fd7cad837f23b5214eb
MD5 8ce8a913bfd1d43bc3b4da92f900971a
BLAKE2b-256 2a7d0ac7778c6ce4c1fe028d900fa00574d9b14262cf2c1932b4146506de46c8

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