Getting Started

Prerequisites

• Python ≥ 3.11
• Poetry ≥ 1.9 — install with pip install poetry

Install dependencies

poetry install

Run in development mode

This opens a native desktop window powered by Flet/Flutter:

poetry run flet run src/kubeidea/app.py

Build desktop executables

Flet includes built-in packaging to produce native executables for Linux, macOS, and Windows from a single Python codebase:

poetry run flet build

Cross-platform builds

The flet build command produces a binary for the OS you are running on. To generate platform-specific packages for all supported systems, the project uses a GitHub Actions release workflow that produces a .deb package for Debian/Ubuntu, a .dmg disk image for macOS, a .zip archive for Windows, a .tar.gz for Fedora, and a .flatpak bundle for any Linux distro with Flatpak support, then attaches them to each GitHub Release.

Run tests

poetry run pytest

Lint & type-check

poetry run ruff check src/ tests/
poetry run mypy src/kubeidea/

Serve the documentation locally

poetry install --with docs
poetry run mkdocs serve

Then open http://127.0.0.1:8000 in your browser.