Metadata-Version: 2.1
Name: contaxy
Version: 0.0.16
Summary: Python package template.
Home-page: https://github.com/ml-tooling/contaxy
Author: ML Tooling Team
Author-email: team@mltooling.org
License: MIT
Project-URL: Changelog, https://github.com/ml-tooling/contaxy/releases
Project-URL: Issue Tracker, https://github.com/ml-tooling/contaxy/issues
Project-URL: Documentation, https://github.com/ml-tooling/contaxy#documentation
Project-URL: Source, https://github.com/ml-tooling/contaxy
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: server
Provides-Extra: dev
License-File: LICENSE

# Python Library Template

_WIP: Document python library._

## Requirements

* Python 3.6+

## Installation

Install via pip:

```bash
pip install --upgrade -e path/to/lib
```

## Usage

After installation, the package can be imported:

```python
import template_package
```

## Development

This library uses [black](https://github.com/psf/black) for auto-formatting, [isort](https://github.com/PyCQA/isort) for import sorting, [flake8](https://github.com/PyCQA/flake8) for linting, [mypy](https://github.com/python/mypy) for type checking, and [pydocstyle](https://github.com/PyCQA/pydocstyle) for docstring style checks. All code is written compatible with Python 3.6+, with type hints wherever possible.

## Testing

* DeploymentManager:
  * By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing `kind create cluster`. Then execute the tests by setting the environment variable `KUBE_AVAILABLE=true` (in VS Code, you can for example set the env variable in the `launch.json` or append it in front of the pytest command, e.g. `KUBE_AVAILABLE=true pytest...`)


