Metadata-Version: 2.5
Name: pycalrissian
Version: 0.8.2
Summary: pycalrissian
Project-URL: Homepage, https://github.com/Terradue/pycalrissian
Author-email: Terradue <fabrice.brito@terradue.com>
License-Expression: EUPL-1.0
License-File: LICENSE
Keywords: kubernetes,pycalrissian
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: cwltool>=3.1.20240708091337
Requires-Dist: kubernetes==35.0.0
Requires-Dist: loguru
Requires-Dist: setuptools>=70.0.0
Requires-Dist: typing-extensions>=4.8.0
Description-Content-Type: text/markdown

# pycalrissian

_pycalrissian_ is a Python client library for running Common Workflow Language (CWL) descriptions on Kubernetes using [Calrissian](https://github.com/Duke-GCB/calrissian).

It provides simple objects and methods to:

* prepare a Kubernetes namespace ready to run Calrissian kubernetes jobs.
* create a Calrissian Kubernetes job in that namespace based on a CWL description and its parameters
* submit and monitor the job execution and retrieve usage, logs and outputs

Refer to the [documentation](https://zoo-project.github.io/pycalrissian/) to get started.

## Development

Use the Visual Studio Code Remote Container configuration.

Requirements:

* in your local `$HOME` you must have a `.kube` folder as it is mounted on the development container to access the kubernetes cluster

**Kubernetes resources for development and testing**

We suggest using microk8s and set the kubeconfig with:

```
microk8s config > ~/.kube/config
```
