lorebase-scribe 0.3.0__tar.gz → 0.4.0__tar.gz

lorebase_scribe-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Antonio Antenore
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lorebase_scribe-0.4.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.5
+Name: lorebase-scribe
+Version: 0.4.0
+Summary: Lorebase Scribe: job worker, scheduler and Source synchronization
+Project-URL: Homepage, https://github.com/aantenore/lorebase
+Project-URL: Documentation, https://aantenore.github.io/lorebase/
+Project-URL: Repository, https://github.com/aantenore/lorebase
+Project-URL: Changelog, https://github.com/aantenore/lorebase/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/aantenore/lorebase/issues
+Author: Antonio Antenore
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: knowledge-graph,mcp,ontology,postgres,versioning
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Requires-Python: >=3.12
+Requires-Dist: asyncpg>=0.29
+Requires-Dist: httpx>=0.27
+Requires-Dist: lorebase-core<0.5,>=0.4
+Requires-Dist: lorebase-inference<0.5,>=0.4
+Requires-Dist: lorebase-platform<0.5,>=0.4
+Requires-Dist: lorebase-store<0.5,>=0.4
+Requires-Dist: opentelemetry-api>=1.25
+Requires-Dist: pydantic>=2.7
+Requires-Dist: sqlalchemy[asyncio]>=2.0.30
+Provides-Extra: documents
+Requires-Dist: pypdf>=4.2; extra == 'documents'
+Requires-Dist: python-docx>=1.1; extra == 'documents'
+Provides-Extra: mssql
+Requires-Dist: pymssql>=2.3; extra == 'mssql'
+Provides-Extra: mysql
+Requires-Dist: asyncmy>=0.2.10; extra == 'mysql'
+Provides-Extra: parquet
+Requires-Dist: pyarrow>=15; extra == 'parquet'
+Description-Content-Type: text/markdown
+
+# lorebase-scribe
+
+Part of [Lorebase](https://github.com/aantenore/lorebase), an open-source ontology platform: a versioned, governed knowledge graph on Postgres with git-like branching and three-way merge.
+
+Scribe, the job worker and scheduler of Lorebase: Source synchronization, extraction, webhooks, index jobs and maintenance passes.
+
+```sh
+uv tool install lorebase-scribe    # or: pip install lorebase-scribe
+lorebase-scribe --help
+```
+
+Documentation: [Scribe](https://aantenore.github.io/lorebase/scribe/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

lorebase_scribe-0.4.0/README.md

@@ -0,0 +1,12 @@
+# lorebase-scribe
+
+Part of [Lorebase](https://github.com/aantenore/lorebase), an open-source ontology platform: a versioned, governed knowledge graph on Postgres with git-like branching and three-way merge.
+
+Scribe, the job worker and scheduler of Lorebase: Source synchronization, extraction, webhooks, index jobs and maintenance passes.
+
+```sh
+uv tool install lorebase-scribe    # or: pip install lorebase-scribe
+lorebase-scribe --help
+```
+
+Documentation: [Scribe](https://aantenore.github.io/lorebase/scribe/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

{lorebase_scribe-0.3.0 → lorebase_scribe-0.4.0}/pyproject.toml

@@ -1,17 +1,31 @@
 [project]
 name = "lorebase-scribe"
-version = "0.3.0"
+version = "0.4.0"
 description = "Lorebase Scribe: job worker, scheduler and Source synchronization"
 requires-python = ">=3.12"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Antonio Antenore" }]
+keywords = ["ontology", "knowledge-graph", "mcp", "postgres", "versioning"]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Database",
+]
 # lorebase-store: job queue, commit pipeline, merges, webhooks, index jobs and GC.
 # lorebase-inference: model interfaces for the extraction jobs to come.
 # httpx: webhook deliveries, CSV Sources served over HTTP(S) and http_json Sources.
 # asyncpg and sqlalchemy: reading Postgres Sources (the drivers the store already uses).
 dependencies = [
-  "lorebase-core>=0.3,<0.4",
-  "lorebase-platform>=0.3,<0.4",
-  "lorebase-store>=0.3,<0.4",
-  "lorebase-inference>=0.3,<0.4",
+  "lorebase-core>=0.4,<0.5",
+  "lorebase-platform>=0.4,<0.5",
+  "lorebase-store>=0.4,<0.5",
+  "lorebase-inference>=0.4,<0.5",
   "sqlalchemy[asyncio]>=2.0.30",
   "asyncpg>=0.29",
   "httpx>=0.27",
@@ -43,8 +57,15 @@ dev = ["testcontainers[mysql,mssql]>=4.8"]
 [project.scripts]
 lorebase-scribe = "lorebase_scribe.__main__:main"
 
+[project.urls]
+Homepage = "https://github.com/aantenore/lorebase"
+Documentation = "https://aantenore.github.io/lorebase/"
+Repository = "https://github.com/aantenore/lorebase"
+Changelog = "https://github.com/aantenore/lorebase/blob/main/CHANGELOG.md"
+Issues = "https://github.com/aantenore/lorebase/issues"
+
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling>=1.27"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]

{lorebase_scribe-0.3.0 → lorebase_scribe-0.4.0}/src/lorebase_scribe/__init__.py

@@ -1,3 +1,3 @@
 """Lorebase Scribe: job worker, scheduler and Source synchronization."""
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"

lorebase_scribe-0.4.0/src/lorebase_scribe/liveness.py

@@ -0,0 +1,168 @@
+"""Liveness of a job loop through a file it rewrites (`scribe.worker.liveness_file`).
+
+Scribe serves no HTTP, so a container healthcheck or a Kubernetes probe reads the file the
+worker rewrites every `scribe.worker.liveness_interval_s`:
+
+    python -m lorebase_scribe.liveness /tmp/scribe-liveness.json [--max-age SECONDS]
+                                       [--min-slots N] [--max-store-age SECONDS]
+
+The check passes (exit 0, one line on stdout) while the file was written within `--max-age`
+(default: `STALE_INTERVALS` times the interval recorded in it) by a loop with at least
+`--min-slots` live slots (default 1); with `--max-store-age` the loop must also have reached
+the store, by a claim or a heartbeat, within that long (a readiness probe). Otherwise it exits
+1 and says why: no file (the worker has not started, or the setting is unset), a stale file
+(the process hangs or is gone), no live slot, or a store not reached. The module imports the
+standard library only, so a check costs one interpreter start.
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import os
+import time
+from collections.abc import Sequence
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+STALE_INTERVALS = 3
+"""Default `--max-age`, as a multiple of the interval the file records."""
+
+
+@dataclass(frozen=True)
+class Liveness:
+    """What the loop reports: written by `write_liveness`, read back by `check_liveness`."""
+
+    worker: str
+    interval_s: float
+    live_slots: int
+    configured_slots: int
+    running: tuple[int, ...]
+    store_reached_at: float | None
+    """Wall-clock time (`time.time()`) of the last claim or heartbeat round trip."""
+    written_at: float
+
+    def as_dict(self) -> dict[str, Any]:
+        return {
+            "worker": self.worker,
+            "interval_s": self.interval_s,
+            "slots": {"live": self.live_slots, "configured": self.configured_slots},
+            "running": list(self.running),
+            "store_reached_at": self.store_reached_at,
+            "written_at": self.written_at,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> Liveness:
+        slots = data["slots"]
+        reached = data.get("store_reached_at")
+        return cls(
+            worker=str(data["worker"]),
+            interval_s=float(data["interval_s"]),
+            live_slots=int(slots["live"]),
+            configured_slots=int(slots["configured"]),
+            running=tuple(int(job) for job in data.get("running", [])),
+            store_reached_at=None if reached is None else float(reached),
+            written_at=float(data["written_at"]),
+        )
+
+
+def write_liveness(path: Path, state: Liveness) -> None:
+    """Write `state` to `path` in one step (a reader never sees a partial file)."""
+    path.parent.mkdir(parents=True, exist_ok=True)
+    tmp = path.with_name(f"{path.name}.{os.getpid()}.tmp")
+    tmp.write_text(json.dumps(state.as_dict(), sort_keys=True))
+    os.replace(tmp, path)
+
+
+def remove_liveness(path: Path) -> None:
+    """Remove the file (a loop that stopped leaves none behind for a probe to trust)."""
+    path.unlink(missing_ok=True)
+
+
+def read_liveness(path: Path) -> Liveness:
+    """The state in `path`; `OSError` when it cannot be read, `ValueError` when it is not one."""
+    try:
+        return Liveness.from_dict(json.loads(path.read_text()))
+    except (KeyError, TypeError, json.JSONDecodeError) as exc:
+        raise ValueError(f"not a liveness file: {exc}") from exc
+
+
+def check_liveness(
+    path: Path,
+    *,
+    now: float | None = None,
+    max_age_s: float | None = None,
+    min_slots: int = 1,
+    max_store_age_s: float | None = None,
+) -> tuple[bool, str]:
+    """Whether the file says the loop is live, and one line saying why."""
+    try:
+        state = read_liveness(path)
+    except OSError as exc:
+        return (
+            False,
+            f"no liveness file at {path} ({exc.strerror or exc}): the worker has not started",
+        )
+    except ValueError as exc:
+        return False, f"{path}: {exc}"
+    at = time.time() if now is None else now
+    age = at - state.written_at
+    limit = state.interval_s * STALE_INTERVALS if max_age_s is None else max_age_s
+    summary = (
+        f"{state.live_slots} of {state.configured_slots} slots live, "
+        f"{len(state.running)} jobs running, written {age:.1f} s ago"
+    )
+    if age > limit:
+        return False, f"liveness file is {age:.1f} s old (limit {limit:g} s): {summary}"
+    if state.live_slots < min_slots:
+        return False, f"fewer than {min_slots} live slots: {summary}"
+    if max_store_age_s is not None:
+        if state.store_reached_at is None:
+            return False, f"the store was not reached yet: {summary}"
+        store_age = at - state.store_reached_at
+        if store_age > max_store_age_s:
+            return (
+                False,
+                f"the store was last reached {store_age:.1f} s ago (limit "
+                f"{max_store_age_s:g} s): {summary}",
+            )
+    return True, f"live: {summary}"
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="python -m lorebase_scribe.liveness", description=__doc__.split("\n")[0]
+    )
+    parser.add_argument("path", type=Path, help="The file named by scribe.worker.liveness_file.")
+    parser.add_argument(
+        "--max-age",
+        type=float,
+        default=None,
+        metavar="SECONDS",
+        help=f"Oldest file accepted (default: {STALE_INTERVALS} times the interval it records).",
+    )
+    parser.add_argument(
+        "--min-slots", type=int, default=1, metavar="N", help="Live slots required (default 1)."
+    )
+    parser.add_argument(
+        "--max-store-age",
+        type=float,
+        default=None,
+        metavar="SECONDS",
+        help="Also require the store reached within this long (a readiness probe).",
+    )
+    args = parser.parse_args(argv)
+    live, reason = check_liveness(
+        args.path,
+        max_age_s=args.max_age,
+        min_slots=args.min_slots,
+        max_store_age_s=args.max_store_age,
+    )
+    print(reason)
+    return 0 if live else 1
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

{lorebase_scribe-0.3.0 → lorebase_scribe-0.4.0}/src/lorebase_scribe/settings.py

@@ -57,6 +57,22 @@ class WorkerSettings(SectionModel):
         "(collections and index builds run long). Postgres Sources use "
         "scribe.sources.postgres.statement_timeout_ms.",
     )
+    outcome_retry_delay_s: float = Field(
+        default=1.0,
+        ge=0,
+        description="Pause before the one more try at writing a job's outcome when the first "
+        "write failed (a dropped connection, a statement timeout). When that fails too the "
+        "job counts as unrecorded and runs again once its lock goes stale.",
+    )
+    liveness_file: str | None = Field(
+        default=None,
+        description="Path of a file the job loop rewrites every liveness_interval_s with its "
+        "live slots, running jobs and the time it last reached the store, for a container "
+        "healthcheck or a probe (`python -m lorebase_scribe.liveness FILE`); null writes none.",
+    )
+    liveness_interval_s: float = Field(
+        default=10.0, gt=0, description="How often the liveness file is rewritten."
+    )
     principal: str = Field(
         default="svc_scribe",
         min_length=1,

{lorebase_scribe-0.3.0 → lorebase_scribe-0.4.0}/src/lorebase_scribe/telemetry.py

@@ -157,3 +157,36 @@ meter.create_observable_gauge(
     description="Open reconciliation candidates by Domain and type, counted by each "
     "reconcile_sweep job.",
 )
+
+
+class WorkerSlots:
+    """The slots of this process's job loop as the worker last reported them: `live` run the
+    claim loop, `lost` ended with an error and wait to be started again. Nothing is reported
+    before the worker runs or after it stopped."""
+
+    def __init__(self) -> None:
+        self._lock = Lock()
+        self._counts: dict[str, int] | None = None
+
+    def update(self, *, live: int, configured: int) -> None:
+        with self._lock:
+            self._counts = {"live": live, "lost": max(configured - live, 0)}
+
+    def clear(self) -> None:
+        with self._lock:
+            self._counts = None
+
+    def observe(self, _options: CallbackOptions | None = None) -> Iterable[Observation]:
+        with self._lock:
+            counts = dict(self._counts or {})
+        return [Observation(count, {"state": state}) for state, count in sorted(counts.items())]
+
+
+WORKER_SLOTS = WorkerSlots()
+meter.create_observable_gauge(
+    "lorebase.scribe.worker.slots",
+    callbacks=[WORKER_SLOTS.observe],
+    unit="{slot}",
+    description="Slots of this process's job loop by state: live (claiming and running jobs) "
+    "or lost (ended with an error; started again after scribe.worker.poll_interval_s).",
+)