Skip to main content

A Twisted-based Kubernetes client.

Project description

PyPI Package CI status Coverage

What is this?

txkube is a Twisted-based client library for interacting with Kubernetes.

Usage Sample

from __future__ import print_function
from twisted.internet.task import react

from txkube import network_kubernetes_from_context

@react
def main(reactor):
    k8s = network_kubernetes_from_context(reactor)
    d = k8s.versioned_client()
    d.addCallback(
        lambda client: client.list(client.model.v1.Namespace)
    )
    d.addCallback(print)
    return d

Installing

To install the latest version of txkube using pip:

$ pip install txkube

For additional development dependencies, install the dev extra:

$ pip install txkube[dev]

Testing

txkube uses pyunit-style tests. After installing the development dependencies, you can run the test suite with trial:

$ pip install txkube[dev]
$ trial txkube

txkube also includes integration tests. It is not recommended that you run these against anything but a dedicated testing Kubernetes cluster. Minikube is an easy way to obtain such a thing. Once running:

$ pip install txkube[dev]
$ TXKUBE_INTEGRATION_CONTEXT=minikube trial txkube

This will run the full test suite which includes the integration tests. It will interact with (and make destructive changes to) the identified Kubernetes cluster.

License

txkube is open source software released under the MIT License. See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
txkube-0.3.0-py2-none-any.whl (158.8 kB) Copy SHA256 hash SHA256 Wheel py2 Aug 8, 2018
txkube-0.3.0.tar.gz (143.2 kB) Copy SHA256 hash SHA256 Source None Aug 8, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page