lutaml-store 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6093f17ea0bca9240b608835a29b8f060a0c8c41be950e93fc0713e8c1b9444
-  data.tar.gz: f0f9ee8ace22fa22ec62408425ba7fa479648c57158c92967bc8e235fd037285
+  metadata.gz: 34e9babf679b2654a563c89d68552afd0b2d98d5725656eb9baa2f1a878a80f4
+  data.tar.gz: 599409d62bfe96b0e57147f620aef55ea88abe40b5183bdfb02511d3a91ea281
 SHA512:
-  metadata.gz: 97a8aa5dc0d52617b1f4d97bd8378664eead01e299410d8dd506b775be23d69616008cde2e053b6a649819726048afdd2b227a455979630b2f07d04e76deed6d
-  data.tar.gz: b80834cd232f87d378c0a3a5f7ea17ef2c7ea2d68103d890756eabb2f2c85e20e1b1f193ec64cd0198fdb4235c0ff68ca6de87e788b7aabaa26b49a081e2023e
+  metadata.gz: 77f4022441c6b6ab2f63b5106a2ca3bba16abab82bf75adbe8569ec73a0eb6cd824891920e5571e7a2f7b39c9d56ac5bd2824418f24aa8577abf893645941062
+  data.tar.gz: dbe7804392b8b32135c77f3766b6976a8111a357b40bfdad563906d59205a0305dfd3f467b371ba423859a6ebbb8a7fa8d8baef905875a6097478763ed2d6b43

data/README.adoc

@@ -17,8 +17,64 @@ It offers a unified interface for storing and retrieving complex model
 hierarchies, batch file I/O with multiple serialization formats, HTTP-aware
 caching, and package-based persistence with ZIP and directory transports.
 
+It also provides **read-only Sources** for working with data repositories that
+live outside your process — GitHub Pages, any static host, a REST API, a local
+package directory, or a `.zip` distribution — through one facade that never
+guesses which layer answered.
+
+== Quick start: read a LutaML data repository
+
+The same read API whether the data lives in the cloud, a local package, or a
+downloaded `.zip` — backends are configured, never guessed:
+
+[source,ruby]
+----
+require "lutaml/store"
+
+# From a cloud API (api.relaton.org is the reference implementation)
+repo = Lutaml::Store::Repository.new(
+  source: Lutaml::Store::Source.for(:rest,
+    base_url: "https://api.relaton.org", collection: "ietf"),
+  cache: Lutaml::Store::Source.for(:directory, path: "~/.cache/relaton/ietf"),
+)
+
+# From a local GCR-style package — identical read API
+repo = Lutaml::Store::Repository.new(
+  source: Lutaml::Store::Source.for(:directory, path: "~/gcr/relaton/ietf"),
+)
+
+# From a downloaded .zip distribution — same API
+repo = Lutaml::Store::Repository.new(
+  source: Lutaml::Store::Source.for(:zip, path: "ietf.zip"),
+)
+
+# Read
+repo.read("RFC 7231")        # => bytes
+repo.exist?("RFC 7231")      # => true
+repo.keys                     # => ["RFC 7231", ...]
+repo.manifest                 # => Lutaml::Store::Manifest
+
+# Parse into your model — the model class is declared, never inferred
+repo.get("RFC 7231", MyModel)
+
+# Search by metadata fields
+repo.search(docid: "RFC 7231")
+
+# Pull the whole collection into a local GCR-style package
+repo.pull!(into: "~/gcr/relaton", collection: "ietf")
+
+# Offline mode: never touch the source, serve from the local package only
+offline = Lutaml::Store::Repository.new(source: repo.source, cache: repo.cache, mode: :offline)
+offline.read("RFC 7231")     # served from the cache, no network
+
+
+
 == Features
 
+* **Repository** — the uniform facade: one read API over any source (cloud, local, zip), explicit cache, online/offline modes
+* **Source** (read-only) — Directory, Zip, Https (ETag/304), Rest (the lutaml cloud store API); 404 = NotFoundError, transport = BackendError
+* **Manifest** — the enumeration SSOT: keys, sha256 digests, opaque shard metadata
+* **Mirror** — pull any source into a GCR-style package (incremental, digest-verified); pack to a distributable .zip
 * **DatabaseStore** — high-level CRUD with model registry, polymorphism, composites
 * **PackageStore** — structured multi-model packages with ZIP and directory transport
 * **BasicStore** — low-level key-value store with optional cache, events, monitoring

data/docs/astro.config.mjs

@@ -0,0 +1,12 @@
+import { defineConfig } from "astro/config";
+import vue from "@astrojs/vue";
+import tailwindcss from "@tailwindcss/vite";
+
+export default defineConfig({
+  site: "https://lutaml.github.io",
+  base: "/lutaml-store",
+  integrations: [vue()],
+  vite: {
+    plugins: [tailwindcss()],
+  },
+});