deped-runtime

deped-runtime is the dependency-light operational layer shared by DepEd data repositories. It provides reusable artifact, file, SQLite, SQL, Rich console, workbook, source-staging, source-product, GeoParquet, WKB geometry, profiling, R2, pagination, and notebook-presentation mechanics. Producer schemas, ingestion policy, semantic normalization, artifact contracts, and application state stay with the repository that defines them.

Install

The base package includes artifact, CSV, OOXML, text, SQL, SQLite, console, and profile-table support:

uv add deped-runtime

Install only the optional runtime integration a consumer needs:

uv add 'deped-runtime[excel]'   # openpyxl workbook helpers
uv add 'deped-runtime[polars]'  # SQLite query/source frames
uv add 'deped-runtime[geoparquet]'  # GeoParquet and WKB polygon mechanics
uv add 'deped-runtime[r2]'      # Cloudflare R2 API and CLI
uv add 'deped-runtime[notebooks]'      # Marimo and generic Altair components
uv add 'deped-runtime[notebooks-sql]'  # notebook components plus Marimo SQL
uv add 'deped-runtime[notebooks-maps]' # notebook components plus Folium maps
uv add 'deped-runtime[all]'     # all optional integrations

Start by task

• Hash files, count or write CSV rows, and fingerprint sources: see files and workbooks.
• Implement explicit, progress-aware network fetch commands while keeping provider policy local: see source fetching.
• Publish and integrity-check hash-backed source artifacts: see source-product manifests.
• Inspect SQLite, attach sources read-only, validate raw source tables, or return Polars frames: see SQL and SQLite.
• Read and write WKB GeoParquet or simplify polygon batches without breaking valid shared-edge coverages: see GeoParquet and geometry.
• Render consistent command status and build progress: see console and progress.
• Transfer namespaced artifacts with the API or CLI: see R2 transfers.
• Produce a Markdown quality report for a SQLite table: see profile-table.
• Calculate a page window or slice an in-memory sequence without taking over labels and URLs: use deped_runtime.pagination.
• Compose consistent Marimo sidebars, stats, tables, callouts, and charts: see notebook design system.
• Move a consumer from deped-dcp-template 0.9.0: see the migration guide.

The documentation includes the complete module map, installation matrix, and ownership boundary.

Quick examples

from deped_runtime.artifacts import file_sha256
from deped_runtime.sqlite import open_readonly_sqlite, relation_columns

with open_readonly_sqlite("artifacts/example.db") as conn:
    print(file_sha256("artifacts/example.db"))
    print(relation_columns(conn, "example"))

uv run --extra r2 deped-runtime r2 download --target data --prefix deped-example
uv run profile-table artifacts/example.db example

Development

just docs   # serve documentation on http://localhost:8002
just check  # lint, type-check, test, build docs, and build the wheel