kiara-plugin.dev 0.1.0

A kiara plugin to help with development related tasks (modules, pipelines, widgets,...).

kiara plugin: (dev)

A kiara plugin to help with development related tasks (modules, pipelines, widgets,...).

• Documentation: https://DHARPA-Project.github.io/kiara_plugin.dev
• Code: https://github.com/DHARPA-Project/kiara_plugin.dev
• kiara: 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. Check out their install instructions.

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 file in this repository.