| Name | kiara-plugin.dev JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A kiara plugin to help with development related tasks (modules, pipelines, widgets,...). |
| upload_time | 2025-07-14 14:21:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MPL-2.0 |
| keywords |
kiara
kiara-plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.python.org/pypi/kiara_plugin.dev/)
[](https://pypi.python.org/pypi/kiara_plugin.dev/)
[](https://pypi.python.org/pypi/kiara_plugin.dev/)
[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.dev/goto?ref=develop)
[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.dev?branch=develop)
[](https://github.com/ambv/black)
# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (dev)
A kiara plugin to help with development related tasks (modules, pipelines, widgets,...).
- Documentation: [https://DHARPA-Project.github.io/kiara_plugin.dev](https://DHARPA-Project.github.io/kiara_plugin.dev)
- Code: [https://github.com/DHARPA-Project/kiara_plugin.dev](https://github.com/DHARPA-Project/kiara_plugin.dev)
- `kiara`: [https://docs.dharpa.org](https://docs.dharpa.org)
## Description
TODO
## Development
### Requirements
- uv ( https://docs.astral.sh/uv/ )
- git
- make (on Linux / Mac OS X -- optional)
### Check out the source code & enter the project directory
```
git clone https://github.com/DHARPA-Project/kiara_plugin.dev
cd kiara_plugin.dev
```
### Prepare development environment
The recommended way to setup a development environment is to use [uv](https://docs.astral.sh/uv/). Check out [their install instructions](https://docs.astral.sh/uv/getting-started/installation/).
Once you have `uv` installed, you can either run `kiara` using the `uv run` command:
```
uv run kiara module list
```
or, activate the virtual environment and run `kiara` directly:
```
uv sync # to make sure the virtualenv exists (and is up to date)
source .venv/bin/activate
kiara module list
```
### Running pre-defined development-related tasks
The included `Makefile` file includes some useful tasks that help with development. This requires `uv` and the `make` tool to be
installed, which should be the case for Linux & Mac OS X systems.
- `make test`: runs the unit tests
- `make mypy`: run mypy checks
- `make lint`: run the `ruff` linter on the source code
- `make format`: run the `ruff` formatter on the source code (similar to `black`)
Alternatively, if you don't have the `make` command available, you can use `uv` directly to run those tasks:
- `uv run pytest tests`
- `uv run mypy src/`
- `uv run ruff check --fix src/`
- `uv run ruff format src/`
## Copyright & license
This project is MPL v2.0 licensed, for the license text please check the [LICENSE](/LICENSE) file in this repository.
Raw data
{
"_id": null,
"home_page": null,
"name": "kiara-plugin.dev",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "kiara, kiara-plugin",
"author": null,
"author_email": "Markus Binsteiner <markus@frkl.dev>",
"download_url": "https://files.pythonhosted.org/packages/50/95/fea113e39877a478a2390645a71b027eb44e907c9dcbb293e3e4664ba519/kiara_plugin_dev-0.2.0.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/kiara_plugin.dev/)\n[](https://pypi.python.org/pypi/kiara_plugin.dev/)\n[](https://pypi.python.org/pypi/kiara_plugin.dev/)\n[](https://actions-badge.atrox.dev/DHARPA-Project/kiara_plugin.dev/goto?ref=develop)\n[](https://coveralls.io/github/DHARPA-Project/kiara_plugin.dev?branch=develop)\n[](https://github.com/ambv/black)\n\n# [**kiara**](https://dharpa.org/kiara.documentation) plugin: (dev)\n\nA kiara plugin to help with development related tasks (modules, pipelines, widgets,...).\n\n - Documentation: [https://DHARPA-Project.github.io/kiara_plugin.dev](https://DHARPA-Project.github.io/kiara_plugin.dev)\n - Code: [https://github.com/DHARPA-Project/kiara_plugin.dev](https://github.com/DHARPA-Project/kiara_plugin.dev)\n - `kiara`: [https://docs.dharpa.org](https://docs.dharpa.org)\n\n## Description\n\nTODO\n\n## Development\n\n### Requirements\n\n- uv ( https://docs.astral.sh/uv/ )\n- git\n- make (on Linux / Mac OS X -- optional)\n\n### Check out the source code & enter the project directory\n\n```\ngit clone https://github.com/DHARPA-Project/kiara_plugin.dev\ncd kiara_plugin.dev\n```\n\n### Prepare development environment\n\nThe recommended way to setup a development environment is to use [uv](https://docs.astral.sh/uv/). Check out [their install instructions](https://docs.astral.sh/uv/getting-started/installation/).\n\nOnce you have `uv` installed, you can either run `kiara` using the `uv run` command:\n\n```\nuv run kiara module list\n```\n\nor, activate the virtual environment and run `kiara` directly:\n\n```\nuv sync # to make sure the virtualenv exists (and is up to date)\nsource .venv/bin/activate\nkiara module list\n```\n\n### Running pre-defined development-related tasks\n\nThe included `Makefile` file includes some useful tasks that help with development. This requires `uv` and the `make` tool to be\ninstalled, which should be the case for Linux & Mac OS X systems.\n\n- `make test`: runs the unit tests\n- `make mypy`: run mypy checks\n- `make lint`: run the `ruff` linter on the source code\n- `make format`: run the `ruff` formatter on the source code (similar to `black`)\n\nAlternatively, if you don't have the `make` command available, you can use `uv` directly to run those tasks:\n\n- `uv run pytest tests`\n- `uv run mypy src/`\n- `uv run ruff check --fix src/`\n- `uv run ruff format src/`\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",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "A kiara plugin to help with development related tasks (modules, pipelines, widgets,...).",
"version": "0.2.0",
"project_urls": {
"documentation": "https://DHARPA-Project.github.io/kiara_plugin.dev",
"homepage": "https://github.com/DHARPA-Project/kiara_plugin.dev",
"repository": "https://github.com/DHARPA-Project/kiara_plugin.dev"
},
"split_keywords": [
"kiara",
" kiara-plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d5fcfb517558509297a91c5510c83ea1da0707067d16ecba0eda6f46a42d4f24",
"md5": "f27637b6534e1dbdb27aee0b2d975724",
"sha256": "125eac7ac4c5123de53ef8c407132dc525fccdb80eb9b0ce8127b9d1de5e8660"
},
"downloads": -1,
"filename": "kiara_plugin_dev-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f27637b6534e1dbdb27aee0b2d975724",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 36179,
"upload_time": "2025-07-14T14:21:14",
"upload_time_iso_8601": "2025-07-14T14:21:14.822219Z",
"url": "https://files.pythonhosted.org/packages/d5/fc/fb517558509297a91c5510c83ea1da0707067d16ecba0eda6f46a42d4f24/kiara_plugin_dev-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5095fea113e39877a478a2390645a71b027eb44e907c9dcbb293e3e4664ba519",
"md5": "dcff8a47501167f490d9b811ec64d0cf",
"sha256": "806aceff8237337e1d22451f67c33d5c9fa767d37bab262aa812bd16282ed434"
},
"downloads": -1,
"filename": "kiara_plugin_dev-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "dcff8a47501167f490d9b811ec64d0cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 42228,
"upload_time": "2025-07-14T14:21:15",
"upload_time_iso_8601": "2025-07-14T14:21:15.949697Z",
"url": "https://files.pythonhosted.org/packages/50/95/fea113e39877a478a2390645a71b027eb44e907c9dcbb293e3e4664ba519/kiara_plugin_dev-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-14 14:21:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DHARPA-Project",
"github_project": "kiara_plugin.dev",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kiara-plugin.dev"
}
