Metadata-Version: 2.4
Name: s-kanban
Version: 0.1.0a2
Summary: S-Kanban reference application for Sovereign Core
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/sovereign-protocol/s-kanban
Project-URL: Source, https://github.com/sovereign-protocol/s-kanban
Project-URL: Issues, https://github.com/sovereign-protocol/s-kanban/issues
Keywords: local-first,collaboration,sovereign-protocol
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSES/CC-BY-4.0.txt
Requires-Dist: sovereign-protocol<0.2,>=0.1.1
Provides-Extra: test
Requires-Dist: pytest<10,>=8; extra == "test"
Provides-Extra: desktop
Requires-Dist: pywebview<6,>=5; extra == "desktop"
Dynamic: license-file

# S-Kanban

S-Kanban is a local-first Kanban application built on Sovereign Core. Every
participant keeps an explicit local perspective; differences are visible and
resolved by human-controlled adopt or rollback reactions rather than silent
central overwrites.

## Quickstart

Requires Python 3.10+ and Sovereign Core `>=0.1.0,<0.2`.

```powershell
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -e .
.\.venv\Scripts\sovereign-host.exe 9305 config/kanban.example.json
```

Open <http://127.0.0.1:9305>. Direct HTTP is intended for LAN/VPN use. Local
folder and SFTP mailbox channels are configured through relay targets.

## Desktop window

The same host can draw into its own window instead of a browser tab:

```powershell
.\.venv\Scripts\python.exe -m pip install -e ".[desktop]"
.\.venv\Scripts\s-kanban-desktop.exe
```

The window picks a free port at start-up, so boards are kept in a per-user
directory (`%LOCALAPPDATA%\S-Kanban` on Windows) rather than beside the port
number. Pass a config file to override anything, including `storage_file`.

### Building the executable

```powershell
.\.venv\Scripts\python.exe -m pip install pyinstaller
.\.venv\Scripts\pyinstaller.exe S-Kanban.spec
```

The result is `dist/S-Kanban.exe`, bundling this application and the Core it
runs on. Building it for your own use carries no distribution obligations.
Passing that executable to anyone else does: `sovereign` is
LGPL-3.0-or-later, so its notices and relinking terms travel with the binary.
Publish source or wheels unless you have checked those terms.

## License

Application software and assets are Apache-2.0. Documentation is CC-BY-4.0.
Sovereign Core is a separately replaceable LGPL-3.0-or-later dependency.
