Metadata-Version: 2.1
Name: k8kat
Version: 0.1.1
Summary: Sugar for Kubernetes
Home-page: https://github.com/nmachine-cs/k8kat
Author: NMachine
Author-email: xavier@nmachine.io
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown


[![PyPI pyversions](https://img.shields.io/pypi/pyversions/k8kat.svg)](https://pypi.python.org/pypi/k8kat/)
[![PyPI version fury.io](https://badge.fury.io/py/k8kat.svg)](https://pypi.org/project/k8kat/)
[![Client Support Level](https://img.shields.io/badge/kubernetes%20client-alpha-green.svg?style=plastic&colorA=306CE8)](/contributors/design-proposals/api-machinery/csi-new-client-library-procedure.md#client-support-level)
[![codecov](https://codecov.io/gh/nectar-cs/k8kat/branch/master/graph/badge.svg)](https://codecov.io/gh/nectar-cs/k8kat)

## Development

### Environment Setup

During development, use symlinks to include this package instead of pipenv:
`cd /project/using/k8kat`
`ln -s $k8kat_path/k8kat`

### Building

https://packaging.python.org/tutorials/packaging-projects/
`python3 setup.py sdist bdist_wheel`
`python3 -m twine upload dist/*`
or 
`twine upload dist/*`

### Cluster Authentication

By default it works as kubectl - try to find kubeconfig and reads authentication data.

### Playing Around

`pipenv shell`

run examples from `examples/`:

`python examples/list_pod.py`

### Test Suite

Run unit-tests (no cluster required): 

`python3 -m unittest discover -v k8kat/tests`

Run e2e-test (you should be using an empty cluster):

`python3 -m unittest discover -v k8kat/e2e-tests`


### Formating, typing

Use Black to formate code

`black .`

To run type checker

`mypy k8kat examples/`




