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

# swimc

SWIMC CLI host package.

This package provides:

- `swimc` console entrypoint
- plugin discovery via `entry_points`
- plugin installation via `swimc plugins install`
- local development fallback that scans sibling plugin `pyproject.toml` files
- a small Python API (`SwimcKit`)

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/swimc
python .\cli\install.py swimc-plugin-data-swv
```

Then list discovered plugins:

```powershell
swimc plugins list
swimc plugins install --dry-run swimc-plugin-data-swv
```

For PyPI-only installation:

```powershell
swimc plugins install --online swimc-plugin-data-swv
```

## Python API

```python
from swimc import SwimcKit

kit = SwimcKit()
plugins = kit.list_plugins("data")
summary = kit.read_data("swv", input="D:/data/sample.swv", include_values=True)
```

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