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

Uploaded Source

Built Distribution

kr8s-0.8.8-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.8.tar.gz
  • Upload date:
  • Size: 31.2 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.8.tar.gz
Algorithm Hash digest
SHA256 76167cbdc2a8d013783a43a1c37ac9ab73672a94df97f9f3708f34144e6400a1
MD5 cd78d266931ddd127c6ecdc8609267f1
BLAKE2b-256 820a3888cc1e5c2c8fe468d9bb29fbf4cc03a928752e23ecbd9d55255d996b0b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.8-py3-none-any.whl
  • Upload date:
  • Size: 39.2 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9001e507c6933872348923dd7c38b71d6031ac9d2339273e457bb7676ce334ea
MD5 146c1151c66258a35929febd90e11645
BLAKE2b-256 9274337c684ebd72240af7f5ff0c03d4e0cfa9910f2d16b0d7977193739bdfb8

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