Metadata-Version: 2.4
Name: kiara
Version: 0.5.16
Summary: Data-centric workflow orchestration.
Project-URL: homepage, https://github.com/DHARPA-Project/kiara
Project-URL: documentation, https://dharpa.org/kiara.documentation
Project-URL: repository, https://github.com/DHARPA-Project/kiara
Author-email: Markus Binsteiner <markus@frkl.io>
License: MPL-2.0
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: kiara
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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 :: 3.13
Requires-Python: >=3.9
Requires-Dist: airium>=0.2.7
Requires-Dist: appdirs<2.0.0,>=1.4.4
Requires-Dist: bidict>=0.21.0
Requires-Dist: boltons>=21.0.0
Requires-Dist: click>=8.1.0
Requires-Dist: copier<10.0.0,>=9.7.0
Requires-Dist: dag-cbor<0.4.0,>=0.3.3
Requires-Dist: deepdiff<9.0.0,>=8.5.0
Requires-Dist: distro>=1.6.0
Requires-Dist: docstring-parser>=0.15.0
Requires-Dist: dpath>=2.0.0
Requires-Dist: email-validator>=2.1.0.post1
Requires-Dist: fasteners>=0.18
Requires-Dist: filetype<2.0.0,>=1.0.0
Requires-Dist: httpx>=0.23.0
Requires-Dist: humanfriendly>=10.0
Requires-Dist: importlib-metadata>=3.0.0.0
Requires-Dist: jinja2>=3.0.1
Requires-Dist: lz4>=4.3.0
Requires-Dist: mistune>=3.0.0
Requires-Dist: mmh3>=3.5.1
Requires-Dist: multiformats-config<0.4.0,>=0.3.1
Requires-Dist: multiformats<0.4.0,>=0.3.1
Requires-Dist: networkx<4.0,>=3.0
Requires-Dist: orjson>=3.8.10
Requires-Dist: patool>=1.12
Requires-Dist: pip>=25.0.0
Requires-Dist: pp-ez>=0.2.0
Requires-Dist: puremagic>=1.15
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: pydantic<3.0.0,>=2.0.0
Requires-Dist: pytz>=2022.6
Requires-Dist: pyzmq>=25.0.0
Requires-Dist: regex>=2022.4.0
Requires-Dist: rich-click>=1.8.9
Requires-Dist: rich>=14.0.0
Requires-Dist: ruamel-yaml<0.19.0,>=0.18.0
Requires-Dist: sortedcontainers>=2.4.0
Requires-Dist: sqlalchemy>=2.0.20
Requires-Dist: stevedore<6.0.0,>=5.0.0
Requires-Dist: structlog>=21.5.0
Requires-Dist: typing-extensions>=4.12.0
Requires-Dist: typing-validation>=1.2.11
Requires-Dist: tzlocal<6.0,>=2.1
Requires-Dist: zstandard>=0.22.0
Provides-Extra: dev-utils
Requires-Dist: build; extra == 'dev-utils'
Requires-Dist: ipython; extra == 'dev-utils'
Requires-Dist: just-bin; (sys_platform != 'win32') and extra == 'dev-utils'
Requires-Dist: kiara-plugin-core-types; extra == 'dev-utils'
Requires-Dist: kiara-plugin-develop; extra == 'dev-utils'
Requires-Dist: mypy>=1.13.0; extra == 'dev-utils'
Requires-Dist: pandas-stubs; extra == 'dev-utils'
Requires-Dist: pdoc; extra == 'dev-utils'
Requires-Dist: pre-commit>=4.0.0; extra == 'dev-utils'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev-utils'
Requires-Dist: pytest-xdist>=3.2.1; extra == 'dev-utils'
Requires-Dist: pytest>=6.2.2; extra == 'dev-utils'
Requires-Dist: ruff>=0.4.1; extra == 'dev-utils'
Requires-Dist: sqlalchemy-stubs; extra == 'dev-utils'
Requires-Dist: types-colorama; extra == 'dev-utils'
Requires-Dist: types-decorator; extra == 'dev-utils'
Requires-Dist: types-deprecated; extra == 'dev-utils'
Requires-Dist: types-humanfriendly; extra == 'dev-utils'
Requires-Dist: types-markdown; extra == 'dev-utils'
Requires-Dist: types-networkx; extra == 'dev-utils'
Requires-Dist: types-orjson; extra == 'dev-utils'
Requires-Dist: types-pexpect; extra == 'dev-utils'
Requires-Dist: types-pygments; extra == 'dev-utils'
Requires-Dist: types-python-dateutil; extra == 'dev-utils'
Requires-Dist: types-pytz; extra == 'dev-utils'
Requires-Dist: types-pyyaml; extra == 'dev-utils'
Requires-Dist: types-setuptools; extra == 'dev-utils'
Requires-Dist: types-tzlocal; extra == 'dev-utils'
Requires-Dist: watchdog; extra == 'dev-utils'
Requires-Dist: wheel; extra == 'dev-utils'
Provides-Extra: jupyter
Requires-Dist: ipydagred3; extra == 'jupyter'
Requires-Dist: jupyterlab; extra == 'jupyter'
Provides-Extra: marimo
Requires-Dist: altair<6.0.0,>=5.5.0; extra == 'marimo'
Requires-Dist: marimo; extra == 'marimo'
Description-Content-Type: text/markdown

[![PyPI status](https://img.shields.io/pypi/status/kiara.svg)](https://pypi.python.org/pypi/kiara/)
[![PyPI version](https://img.shields.io/pypi/v/kiara.svg)](https://pypi.python.org/pypi/kiara/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kiara.svg)](https://pypi.python.org/pypi/kiara/)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FDHARPA-Project%2Fkiara%2Fbadge%3Fref%3Ddevelop&style=flat)](https://actions-badge.atrox.dev/DHARPA-Project/kiara/goto?ref=develop)
[![Coverage Status](https://coveralls.io/repos/github/DHARPA-Project/kiara/badge.svg?branch=develop)](https://coveralls.io/github/DHARPA-Project/kiara?branch=develop)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# kiara

*A data-centric workflow orchestration framework.*

 - *kiara* user documentation: [https://dharpa.org/kiara.documentation](https://dharpa.org/kiara.documentation/)
 - Code: [https://github.com/DHARPA-Project/kiara](https://github.com/DHARPA-Project/kiara)
 - Development documentation for this repo: [https://dharpa.org/kiara](https://dharpa.org/kiara)

## Description

*Kiara* is the data orchestration engine developed by the DHARPA project. It uses a modular approach
to let users re-use tried and tested data orchestration pipelines, as well as create new ones from existing building
blocks. It also helps you manage your research data, and augment it with automatically-, semi-automatically-, and manually-
created metadata. Most of this is not yet implemented.

## Development

### Requirements

- Python (version >=3.6 -- some make targets only work for Python >=3.7, but *kiara* itself should work on 3.6)
- pip, virtualenv
- git
- make
- [direnv](https://direnv.net/) (optional)


### Prepare development environment

```console
git clone https://github.com/DHARPA-Project/kiara.git
cd kiara
python3 -m venv .venv
source .venv/bin/activate
make init
```

If you use [direnv](https://direnv.net/), you can alternatively do:

``` console
git clone https://github.com/DHARPA-Project/kiara.git
cd kiara
cp .envrc.disabled .envrc
direnv allow
make init
```

*Note*: you might want to adjust the Python version in ``.envrc`` (should not be necessary in most cases though)

### ``make`` targets

- ``init``: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)
- ``update-modules``: update default kiara modules package from git
- ``flake``: run *flake8* tests
- ``mypy``: run *mypy* tests
- ``test``: run unit tests
- ``docs``: create static documentation pages (under ``build/site``)
- ``serve-docs``: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentation
- ``clean``: clean build directories

For details (and other, minor targets), check the ``Makefile``.


### Running tests

``` console
> make test
# or
> make coverage
```


## Copyright & license

This project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.

- Copyright (c) 2021, 2022 [DHARPA project](https://dharpa.org)
- Copyright (c) 2021, 2022 Markus Binsteiner
