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

Uploaded Source

Built Distribution

kr8s-0.8.6-py3-none-any.whl (39.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.6.tar.gz
  • Upload date:
  • Size: 31.1 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.6.tar.gz
Algorithm Hash digest
SHA256 fd35828f51163d4f4351575b28e522b25b22431a3467684fe8b0d3eabedf340c
MD5 866c1ddbbe47bc36f9bbc3dae4134815
BLAKE2b-256 b762cc92b71e093fb39f18a5d19c0f5a11e5c65d84e7e9ee93d00a6b1589ddcc

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 39.0 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6feb15923c1e0918182785d9e1e96c31be56e9c1cae34bf03f00cc4dab36e85e
MD5 5c72320e594d1762237ac106725a23bf
BLAKE2b-256 7db1f029bfc57cd636efa992b2ffc55dbbf8c96899574ff86b2b0e480e5eeaac

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