snakelit 0.1.0__tar.gz

snakelit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags: ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0.10.0
+        with:
+          environments: test
+
+      - name: Check formatting
+        run: pixi run -e test ruff format --check src tests
+
+      - name: Lint
+        run: pixi run -e test ruff check src tests
+
+      - name: Typecheck
+        run: pixi run -e test pyright src tests
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0.10.0
+        with:
+          environments: test
+      - name: Run tests
+        run: pixi run -e test pytest -q
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0.10.0
+        with:
+          environments: publish
+
+      - name: Build and check package
+        run: pixi run --environment publish check

snakelit-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+    steps:
+      - uses: googleapis/release-please-action@v5
+        id: release
+        with:
+          # release-type: python updates the version in pyproject.toml,
+          # generates CHANGELOG.md, creates the release PR and the tag.
+          # Use a dedicated PAT instead of GITHUB_TOKEN if the release PR
+          # should itself trigger CI on `main`.
+          release-type: python
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/snakelit/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Pixi
+        uses: prefix-dev/setup-pixi@v0.10.0
+        with:
+          environments: publish
+
+      - name: Build and check package
+        run: pixi run --environment publish check
+
+      # Trusted Publishing (OIDC): no username/password; the PyPI side must
+      # have this repo + workflow (publish.yml) + environment "pypi"
+      # registered as a trusted publisher.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

snakelit-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.1.0 (2026-11-11)
+
+
+### Features
+
+* class FileExplorer ([ab1ea6c](https://github.com/Hocnonsense/snakelit/commit/ab1ea6c68954300488aed9df93fde9ca67caa151))
+* download and delete popup ([63b075f](https://github.com/Hocnonsense/snakelit/commit/63b075f7f46ba40a9a0e47e24632061a89abb8ec))
+* editors[suffix](path, data, key) ([f8a98ff](https://github.com/Hocnonsense/snakelit/commit/f8a98ff8b606b95c5758254e755df06386a097df))
+* file_explorer ([33f4211](https://github.com/Hocnonsense/snakelit/commit/33f421141fcf250ac50ebb1f8e9c7e01fe17db6b))
+* merge from user ([b5b8191](https://github.com/Hocnonsense/snakelit/commit/b5b8191c5b2190812be4932501f31c63ecc35834))
+* preview file ([12aede5](https://github.com/Hocnonsense/snakelit/commit/12aede5dc0d27f1d278e779f9e2d89914ba765ad))
+* table ([5feb10a](https://github.com/Hocnonsense/snakelit/commit/5feb10afe7a755ed74c7d465726e21f55d622d78))
+* upload ([ea412c9](https://github.com/Hocnonsense/snakelit/commit/ea412c9e27d8ba013822e5a597482f505e138996))
+* upload ([f530031](https://github.com/Hocnonsense/snakelit/commit/f53003130bf6b8b57189f885936c50976af22a0b))
+* version_picker ([7dce8be](https://github.com/Hocnonsense/snakelit/commit/7dce8be04203a42e17850ccb0fa73721ec616401))
+* yaml editor support ([005d754](https://github.com/Hocnonsense/snakelit/commit/005d754c9a3f675e55b66e76aae03612449134c1))
+
+
+### Bug Fixes
+
+* compatibility ([682a9dc](https://github.com/Hocnonsense/snakelit/commit/682a9dccffa30ec3fcb19d129203b6923ae00038))
+* edit table ([38884d3](https://github.com/Hocnonsense/snakelit/commit/38884d3c6d7fccfef792495960f37fa21b9207af))
+* edit_for(path: str, store: FileStore... ([16a3db9](https://github.com/Hocnonsense/snakelit/commit/16a3db92e3014649bd1fd4156dddaa582b619244))
+* load table ([8605e2e](https://github.com/Hocnonsense/snakelit/commit/8605e2e39430f3e952f3183e5cb3f36cd4b6ee05))
+* merge ([7b7745b](https://github.com/Hocnonsense/snakelit/commit/7b7745bc885f0bf25482d0c603da4854fe87042a))
+* rerun only if success ([9ded74e](https://github.com/Hocnonsense/snakelit/commit/9ded74ee7bbb48ae55f655e078794f9e171cb002))
+* sys.platform != "emscripten ([5bb47e3](https://github.com/Hocnonsense/snakelit/commit/5bb47e324030d330b133d6ee8ef0ee6bbd7e0308))
+* table with schema ([ceebdc9](https://github.com/Hocnonsense/snakelit/commit/ceebdc963f741bf2723961eff18baca521e1561e))

snakelit-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.5
+Name: snakelit
+Version: 0.1.0
+Summary: Reusable Streamlit widgets for Snakemake workflows
+Requires-Python: >=3.11
+Requires-Dist: jsonschema<5,>=4
+Requires-Dist: pyyaml<7,>=6
+Requires-Dist: streamlit<2,>=1.55
+Provides-Extra: tables
+Requires-Dist: polars<3,>=1.30; extra == 'tables'
+Description-Content-Type: text/markdown
+
+# snakelit
+
+Reusable Streamlit widgets for Snakemake workflows.
+
+`snakelit` collects the UI pieces that otherwise get copied between the Snakemake workflow catalog's browser app and SRPtn.
+
+## Features
+### File explorer
+
+`FileExplorer` knows nothing about the filesystem. Implement `FileStore` and
+hand it over:
+
+```python
+import streamlit as st
+
+from snakelit.file_explorer import FileExplorer
+from snakelit.types import FileStore, Stat
+
+
+class MemoryStore(FileStore): ...
+
+
+if "explorer" not in st.session_state:
+    st.session_state["explorer"] = FileExplorer(
+        "files", MemoryStore({"notes.txt": b"hello\n"})
+    )
+
+st.session_state["explorer"].render()
+```
+
+Click the folder and files to preview and edit, supports uploads and downloads.
+`FileExplorer(..., on_zip=callback)` adds an "Unzip and trigger merge" action for a single uploaded `.zip`; the callback receives `(name, bytes)` and returns whether the page should rerun.
+
+### Schema-driven editors
+
+`snakelit` enables edit configfiles and tables with optional schema.
+Schemas are read-only and used to choose widgets, coerce values and report errors.
+
+#### Configuration
+
+`schema_config` renders a config document as a form and falls back to a raw YAML/JSON editor.
+
+```python
+from snakelit.editor.config import schema_config
+
+errors: list[str] = []
+updated = schema_config(
+    data,
+    errors,
+    schema,
+    header="Workflow configuration",
+    key="config",
+    format="yaml",
+)
+if updated is not None:
+    store.write("config/config.yaml", updated)
+for message in errors:
+    st.error(message)
+```
+
+Passing `edit_file=callback` adds a button next to string values that look like paths; the host decides whether to open or create the file.
+
+#### Tables
+
+`schema_table` does the same for tables and uses the declared row schema to cast columns before editing and validate every row afterwards. It needs the `tables` extra and accepts `csv`, `tsv`, `parquet` and `xlsx`:
+
+```python
+from snakelit.editor.table import schema_table
+
+errors: list[str] = []
+updated = schema_table(
+    data,
+    errors,
+    schema,
+    key="samples",
+    format="tsv",
+)
+```
+
+### Merge view
+
+```python
+from snakelit.merge import diff_files, render_merge
+
+render_merge(
+    store,
+    "Merge me/wf@main (abc1234)",
+    diff_files(store, incoming),
+    base=original_files,
+)
+```
+
+Rows can be applied, finished or deleted; an empty dict means the merge is complete.
+
+## Install
+
+```bash
+pip install snakelit
+pip install "snakelit[tables]"   # table editor and table preview
+```
+
+Python 3.11+ and Streamlit 1.55+.
+
+## Development
+
+```bash
+pixi run -e test pytest -q
+pixi run -e publish check
+```

snakelit-0.1.0/README.md

@@ -0,0 +1,109 @@
+# snakelit
+
+Reusable Streamlit widgets for Snakemake workflows.
+
+`snakelit` collects the UI pieces that otherwise get copied between the Snakemake workflow catalog's browser app and SRPtn.
+
+## Features
+### File explorer
+
+`FileExplorer` knows nothing about the filesystem. Implement `FileStore` and
+hand it over:
+
+```python
+import streamlit as st
+
+from snakelit.file_explorer import FileExplorer
+from snakelit.types import FileStore, Stat
+
+
+class MemoryStore(FileStore): ...
+
+
+if "explorer" not in st.session_state:
+    st.session_state["explorer"] = FileExplorer(
+        "files", MemoryStore({"notes.txt": b"hello\n"})
+    )
+
+st.session_state["explorer"].render()
+```
+
+Click the folder and files to preview and edit, supports uploads and downloads.
+`FileExplorer(..., on_zip=callback)` adds an "Unzip and trigger merge" action for a single uploaded `.zip`; the callback receives `(name, bytes)` and returns whether the page should rerun.
+
+### Schema-driven editors
+
+`snakelit` enables edit configfiles and tables with optional schema.
+Schemas are read-only and used to choose widgets, coerce values and report errors.
+
+#### Configuration
+
+`schema_config` renders a config document as a form and falls back to a raw YAML/JSON editor.
+
+```python
+from snakelit.editor.config import schema_config
+
+errors: list[str] = []
+updated = schema_config(
+    data,
+    errors,
+    schema,
+    header="Workflow configuration",
+    key="config",
+    format="yaml",
+)
+if updated is not None:
+    store.write("config/config.yaml", updated)
+for message in errors:
+    st.error(message)
+```
+
+Passing `edit_file=callback` adds a button next to string values that look like paths; the host decides whether to open or create the file.
+
+#### Tables
+
+`schema_table` does the same for tables and uses the declared row schema to cast columns before editing and validate every row afterwards. It needs the `tables` extra and accepts `csv`, `tsv`, `parquet` and `xlsx`:
+
+```python
+from snakelit.editor.table import schema_table
+
+errors: list[str] = []
+updated = schema_table(
+    data,
+    errors,
+    schema,
+    key="samples",
+    format="tsv",
+)
+```
+
+### Merge view
+
+```python
+from snakelit.merge import diff_files, render_merge
+
+render_merge(
+    store,
+    "Merge me/wf@main (abc1234)",
+    diff_files(store, incoming),
+    base=original_files,
+)
+```
+
+Rows can be applied, finished or deleted; an empty dict means the merge is complete.
+
+## Install
+
+```bash
+pip install snakelit
+pip install "snakelit[tables]"   # table editor and table preview
+```
+
+Python 3.11+ and Streamlit 1.55+.
+
+## Development
+
+```bash
+pixi run -e test pytest -q
+pixi run -e publish check
+```