Metadata-Version: 2.4
Name: heliokit
Version: 0.1.0
Summary: Heliokit CLI host package with component discovery and Python API.
Requires-Python: <3.11,>=3.10
Description-Content-Type: text/markdown

# heliokit

Heliokit CLI host package.

This package provides:

- `heliokit` console entrypoint
- component discovery via `entry_points`
- component installation via `heliokit components install`
- local development fallback that scans sibling component `pyproject.toml` files
- a small Python API (`Heliokit`)

Current package metadata is pinned to `Python 3.10`.

Inside this repository, the CLI acts as a bridge layer over the existing desktop-side
algorithm modules under the repository root.

## Quick Start

From the repository root:

```powershell
pip install ./cli/heliokit
python .\cli\install.py heliokit-data-swv
```

Then list discovered components:

```powershell
heliokit components list
heliokit components install --dry-run heliokit-data-swv
```

For PyPI-only installation:

```powershell
heliokit components install --online heliokit-data-swv
```

## Python API

```python
from heliokit import Heliokit

kit = Heliokit()
components = kit.list_components("data")
summary = kit.read_data("swv", input="D:/data/sample.swv", include_values=True)
```

For a fuller monorepo guide, command examples, and component parameter conventions, see
[`cli/README.md`](../README.md).
