| Name | kiara JSON |
| Version |
0.5.10
JSON |
| download |
| home_page | None |
| Summary | Data-centric workflow orchestration. |
| upload_time | 2024-04-18 08:30:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MPL-2.0 |
| keywords |
kiara
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.python.org/pypi/kiara/)
[](https://pypi.python.org/pypi/kiara/)
[](https://pypi.python.org/pypi/kiara/)
[](https://actions-badge.atrox.dev/DHARPA-Project/kiara/goto?ref=develop)
[](https://coveralls.io/github/DHARPA-Project/kiara?branch=develop)
[](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
Raw data
{
"_id": null,
"home_page": null,
"name": "kiara",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "kiara",
"author": null,
"author_email": "Markus Binsteiner <markus@frkl.io>",
"download_url": "https://files.pythonhosted.org/packages/5b/bc/9901d829ee41fde251a8ef51ed0d7278310c12135cf48432b765100b0037/kiara-0.5.10.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/kiara/)\n[](https://pypi.python.org/pypi/kiara/)\n[](https://pypi.python.org/pypi/kiara/)\n[](https://actions-badge.atrox.dev/DHARPA-Project/kiara/goto?ref=develop)\n[](https://coveralls.io/github/DHARPA-Project/kiara?branch=develop)\n[](https://github.com/ambv/black)\n\n# kiara\n\n*A data-centric workflow orchestration framework.*\n\n - *kiara* user documentation: [https://dharpa.org/kiara.documentation](https://dharpa.org/kiara.documentation/)\n - Code: [https://github.com/DHARPA-Project/kiara](https://github.com/DHARPA-Project/kiara)\n - Development documentation for this repo: [https://dharpa.org/kiara](https://dharpa.org/kiara)\n\n## Description\n\n*Kiara* is the data orchestration engine developed by the DHARPA project. It uses a modular approach\nto let users re-use tried and tested data orchestration pipelines, as well as create new ones from existing building\nblocks. It also helps you manage your research data, and augment it with automatically-, semi-automatically-, and manually-\ncreated metadata. Most of this is not yet implemented.\n\n## Development\n\n### Requirements\n\n- Python (version >=3.6 -- some make targets only work for Python >=3.7, but *kiara* itself should work on 3.6)\n- pip, virtualenv\n- git\n- make\n- [direnv](https://direnv.net/) (optional)\n\n\n### Prepare development environment\n\n```console\ngit clone https://github.com/DHARPA-Project/kiara.git\ncd kiara\npython3 -m venv .venv\nsource .venv/bin/activate\nmake init\n```\n\nIf you use [direnv](https://direnv.net/), you can alternatively do:\n\n``` console\ngit clone https://github.com/DHARPA-Project/kiara.git\ncd kiara\ncp .envrc.disabled .envrc\ndirenv allow\nmake init\n```\n\n*Note*: you might want to adjust the Python version in ``.envrc`` (should not be necessary in most cases though)\n\n### ``make`` targets\n\n- ``init``: init development project (install project & dev dependencies into virtualenv, as well as pre-commit git hook)\n- ``update-modules``: update default kiara modules package from git\n- ``flake``: run *flake8* tests\n- ``mypy``: run *mypy* tests\n- ``test``: run unit tests\n- ``docs``: create static documentation pages (under ``build/site``)\n- ``serve-docs``: serve documentation pages (incl. auto-reload) for getting direct feedback when working on documentation\n- ``clean``: clean build directories\n\nFor details (and other, minor targets), check the ``Makefile``.\n\n\n### Running tests\n\n``` console\n> make test\n# or\n> make coverage\n```\n\n\n## Copyright & license\n\nThis project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.\n\n- Copyright (c) 2021, 2022 [DHARPA project](https://dharpa.org)\n- Copyright (c) 2021, 2022 Markus Binsteiner\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Data-centric workflow orchestration.",
"version": "0.5.10",
"project_urls": {
"documentation": "https://dharpa.org/kiara.documentation",
"homepage": "https://github.com/DHARPA-Project/kiara",
"repository": "https://github.com/DHARPA-Project/kiara"
},
"split_keywords": [
"kiara"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87382d3aa915f74bed7355f41b294f73fee4df3ee8a1ba7c311f579a6f0b8702",
"md5": "3e97e9b665238c7e8790be044f74e764",
"sha256": "7f6861ec2910330a67f997b2878579c66a84ae781137bdde8ba645ebba251476"
},
"downloads": -1,
"filename": "kiara-0.5.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e97e9b665238c7e8790be044f74e764",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 529288,
"upload_time": "2024-04-18T08:30:29",
"upload_time_iso_8601": "2024-04-18T08:30:29.593119Z",
"url": "https://files.pythonhosted.org/packages/87/38/2d3aa915f74bed7355f41b294f73fee4df3ee8a1ba7c311f579a6f0b8702/kiara-0.5.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5bbc9901d829ee41fde251a8ef51ed0d7278310c12135cf48432b765100b0037",
"md5": "1bb512a519ac8bb97d1a19beb4ba6318",
"sha256": "2677568ab64cb9ec28eaa39cac045531bebdcd8a52150ac65be47d96f625e093"
},
"downloads": -1,
"filename": "kiara-0.5.10.tar.gz",
"has_sig": false,
"md5_digest": "1bb512a519ac8bb97d1a19beb4ba6318",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 758659,
"upload_time": "2024-04-18T08:30:32",
"upload_time_iso_8601": "2024-04-18T08:30:32.796470Z",
"url": "https://files.pythonhosted.org/packages/5b/bc/9901d829ee41fde251a8ef51ed0d7278310c12135cf48432b765100b0037/kiara-0.5.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 08:30:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DHARPA-Project",
"github_project": "kiara",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kiara"
}
