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

Uploaded Source

Built Distribution

kr8s-0.8.16-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kr8s-0.8.16.tar.gz
  • Upload date:
  • Size: 31.9 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.16.tar.gz
Algorithm Hash digest
SHA256 54081aa42632294f9fe342ba9f3fbba54b9936421dc184c28dcdf58e904664c2
MD5 f0ba9c34f9f1fe40d26f66219a5b4c7a
BLAKE2b-256 74dc783ad2876b67394c57dafba27af69276288f187a6966d61503174a01b6c1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: kr8s-0.8.16-py3-none-any.whl
  • Upload date:
  • Size: 39.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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 3e68fd55648610ec58c9e5d4ce63566f102569eb56314dfb6b8c90e37470e63d
MD5 66e2177c47f3e4f465443c80afa97d73
BLAKE2b-256 bf420cd4f0e835028065d7cc75ef0d5542f17e08533b1e614d80c80b043adff3

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