Metadata-Version: 2.1
Name: pykube-ng
Version: 0.27
Summary: Python client library for Kubernetes
Home-page: https://github.com/hjacobs/pykube
Author: Eldarion, Inc.
Author-email: development@eldarion.com
License: Apache
Description: pykube-ng
        =========
        
        .. image:: https://img.shields.io/travis/hjacobs/pykube.svg
           :target: https://travis-ci.org/hjacobs/pykube
           :alt: Build status
        
        .. image:: https://coveralls.io/repos/github/hjacobs/pykube/badge.svg?branch=master;_=1
           :target: https://coveralls.io/github/hjacobs/pykube?branch=master
           :alt: Code Coverage
           
        .. image:: https://readthedocs.org/projects/pykube/badge/?version=latest
           :target: https://pykube.readthedocs.io/
           :alt: Documentation
        
        .. image:: https://img.shields.io/pypi/v/pykube-ng.svg
           :target:  https://pypi.python.org/pypi/pykube-ng/
           :alt: PyPI version
        
        .. image:: https://img.shields.io/pypi/pyversions/pykube-ng.svg
           :target:  https://pypi.python.org/pypi/pykube-ng/
           :alt: Python versions
        
        .. image:: https://img.shields.io/badge/license-apache-blue.svg
           :target:  https://pypi.python.org/pypi/pykube-ng/
           :alt: Apache License
        
        Pykube (pykube-ng) is a lightweight Python 3+ client library for Kubernetes.
        
        This is a fork of `kelproject/pykube <https://github.com/kelproject/pykube>`_ which is no longer maintained (archived). Here the original text of the pykube README:
        
            Kel is an open source Platform as a Service (PaaS) from Eldarion, Inc. that
            makes it easy to manage web application deployment and hosting through the
            entire lifecycle from development through testing to production. It adds
            components and tools on top of Kubernetes that help developers manage their
            application infrastructure. Kel builds on Eldarion's 7+ years experience running
            one of the leading Python and Django PaaSes.
            For more information about Kel, see `kelproject.com`_ or follow us on Twitter
            `@projectkel`_.
        
        .. _kelproject.com: http://kelproject.com/
        .. _@projectkel: https://twitter.com/projectkel
        
        Features
        --------
        
        * HTTP interface using requests using kubeconfig for authentication
        * Python native querying of Kubernetes API objects
        
        Installation
        ------------
        
        To install pykube, use pip::
        
            pip install pykube-ng
        
        
        Interactive Console
        -------------------
        
        The ``pykube`` library module can be run as an interactive console locally for quick exploration.
        It will automatically load ``~/.kube/config`` to provide the ``api`` object, and it loads pykube classes (``Deployment``, ``Pod``, ..) into local context:
        
        .. code-block:: bash
        
            python3 -m pykube
            >>> [d.name for d in Deployment.objects(api)] 
        
        
        Usage
        -----
        
        Query for all ready pods in a custom namespace:
        
        .. code:: python
        
            import operator
            import pykube
        
            api = pykube.HTTPClient(pykube.KubeConfig.from_file("~/.kube/config"))
            pods = pykube.Pod.objects(api).filter(namespace="gondor-system")
            ready_pods = filter(operator.attrgetter("ready"), pods)
        
        Access any attribute of the Kubernetes object:
        
        .. code:: python
        
            pod = pykube.Pod.objects(api).filter(namespace="gondor-system").get(name="my-pod")
            pod.obj["spec"]["containers"][0]["image"]
        
        Selector query:
        
        .. code:: python
        
            pods = pykube.Pod.objects(api).filter(
                namespace="gondor-system",
                selector={"gondor.io/name__in": {"api-web", "api-worker"}},
            )
            pending_pods = pykube.objects.Pod.objects(api).filter(
                field_selector={"status.phase": "Pending"}
            )
        
        Watch query:
        
        .. code:: python
        
            watch = pykube.Job.objects(api, namespace="gondor-system")
            watch = watch.filter(field_selector={"metadata.name": "my-job"}).watch()
        
            # watch is a generator:
            for watch_event in watch:
                print(watch_event.type) # 'ADDED', 'DELETED', 'MODIFIED'
                print(watch_event.object) # pykube.Job object
        
        Create a Deployment:
        
        .. code:: python
        
            obj = {
                "apiVersion": "apps/v1",
                "kind": "Deployment",
                "metadata": {
                    "name": "my-deploy",
                    "namespace": "gondor-system"
                },
                "spec": {
                    "replicas": 3,
                    "selector": {
                        "matchLabels": {
                            "app": "nginx"
                        }
                    },
                    "template": {
                        "metadata": {
                            "labels": {
                                "app": "nginx"
                            }
                        },
                        "spec": {
                            "containers": [
                                {
                                    "name": "nginx",
                                    "image": "nginx",
                                    "ports": [
                                        {"containerPort": 80}
                                    ]
                                }
                            ]
                        }
                    }
                }
            }
            pykube.Deployment(api, obj).create()
        
        Delete a Deployment:
        
        .. code:: python
        
            obj = {
                "apiVersion": "apps/v1",
                "kind": "Deployment",
                "metadata": {
                    "name": "my-deploy",
                    "namespace": "gondor-system"
                }
            }
            pykube.Deployment(api, obj).delete()
        
        Check server version:
        
        .. code:: python
        
            api = pykube.HTTPClient(pykube.KubeConfig.from_file())
            api.version
        
        
        Requirements
        ------------
        
        * Python 3.6+
        * requests (included in ``install_requires``)
        * PyYAML (included in ``install_requires``)
        
        
        Local Development
        -----------------
        
        You can run pykube against your current kubeconfig context, e.g. local Minikube_:
        
        .. code-block:: bash
        
            pipenv install --dev
            pipenv run python3
            >>> import pykube
            >>> config = pykube.KubeConfig.from_file()
            >>> api = pykube.HTTPClient(config)
            >>> list(pykube.Deployment.objects(api))
        
        To run PEP8 (flake8) checks and unit tests including coverage report:
        
        .. code-block:: bash
        
            make test
        
        
        License
        -------
        
        The code in this project is licensed under the Apache License, version 2.0
        (included in this repository under LICENSE).
        
        
        Contributing
        ------------
        
        Easiest way to contribute is to provide feedback! We would love to hear what you like and what you think is missing.
        Create an issue or `ping try_except_ on Twitter`_.
        
        PRs are welcome. Please also have a look at `issues labeled with "help wanted"`_.
        
        
        Code of Conduct
        ----------------
        
        In order to foster a kind, inclusive, and harassment-free community, this project follows the `Contributor Covenant Code of Conduct`_.
        
        .. _Contributor Covenant Code of Conduct: http://contributor-covenant.org/version/1/4/
        
        
        .. _ping try_except_ on Twitter: https://twitter.com/try_except_
        .. _issues labeled with "help wanted": https://github.com/hjacobs/pykube/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
        .. _Minikube: https://github.com/kubernetes/minikube
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/x-rst
Provides-Extra: gcp
