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

Uploaded Source

Built Distribution

kr8s-0.8.9-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.9.tar.gz
  • Upload date:
  • Size: 31.3 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.9.tar.gz
Algorithm Hash digest
SHA256 73dce40a7b4bffa3fd6098f91ab72230a13bcb739dfa8d0a74677237757e2202
MD5 a718d046c3c5249ba3936930b05dcec5
BLAKE2b-256 bbf3443512cb36aed973cd6ddabc5ea28c0c125a6fc7bcf1a84ac3802f3217b9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 39.3 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 aa07f4011fa281b62ff4a6745086f90785f2b95f36682f964f9342273ec45836
MD5 064fff00134c3e73d4ccac13c19be691
BLAKE2b-256 7bc6c24a0adc90895d2cdf57396886c84077632877a9d4e004ed01b345df2f67

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