lorebase-platform 0.2.3__tar.gz → 0.3.1__tar.gz

lorebase_platform-0.3.1/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_platform-0.3.1/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.5
+Name: lorebase-platform
+Version: 0.3.1
+Summary: Lorebase platform: settings, secrets, logging and telemetry
+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: opentelemetry-api>=1.25
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.25
+Requires-Dist: opentelemetry-sdk>=1.25
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# lorebase-platform
+
+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.
+
+The shared runtime of the Lorebase services: layered settings, secret references, structured logging and OpenTelemetry setup.
+
+```sh
+pip install lorebase-platform
+```
+
+It is a library of the other Lorebase packages and has no command of its own.
+
+Documentation: [Operations](https://aantenore.github.io/lorebase/operations/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

lorebase_platform-0.3.1/README.md

@@ -0,0 +1,13 @@
+# lorebase-platform
+
+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.
+
+The shared runtime of the Lorebase services: layered settings, secret references, structured logging and OpenTelemetry setup.
+
+```sh
+pip install lorebase-platform
+```
+
+It is a library of the other Lorebase packages and has no command of its own.
+
+Documentation: [Operations](https://aantenore.github.io/lorebase/operations/) and the [documentation site](https://aantenore.github.io/lorebase/). License: Apache-2.0.

lorebase_platform-0.3.1/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "lorebase-platform"
+version = "0.3.1"
+description = "Lorebase platform: settings, secrets, logging and telemetry"
+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",
+]
+dependencies = ["pydantic>=2.7", "pydantic-settings>=2.3", "pyyaml>=6.0", "opentelemetry-api>=1.25", "opentelemetry-sdk>=1.25", "opentelemetry-exporter-otlp-proto-grpc>=1.25"]
+
+[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>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lorebase_platform"]

lorebase_platform-0.3.1/src/lorebase_platform/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.1"

{lorebase_platform-0.2.3 → lorebase_platform-0.3.1}/src/lorebase_platform/secrets.py

@@ -6,6 +6,9 @@ A secret setting holds either a literal value or a reference resolved at load ti
 - `secret://file/PATH`: content of the file at `PATH` (trailing newline removed). Use a double
   slash for an absolute path, for example `secret://file//run/secrets/db_password`.
 
+Other providers (a vault, a cloud secret manager) are added with `register_secret_provider`
+before the settings are loaded; `env` and `file` cannot be replaced.
+
 Resolved values are typed `SecretStr` and are registered so that the logging redaction filter
 can mask them wherever they appear.
 """
@@ -22,8 +25,13 @@ from typing import Annotated, Any
 from pydantic import BeforeValidator, SecretStr
 
 REFERENCE_PREFIX = "secret://"
+_PROVIDER_NAME = re.compile(r"^[a-z0-9_-]+$")
 _REFERENCE = re.compile(r"^secret://(?P<provider>[a-z0-9_-]+)/(?P<target>.+)$")
 
+SecretProvider = Callable[[str], str]
+"""Resolves the target of a reference (the part after `secret://<name>/`) to its value; raises
+`SecretResolutionError`, with a message holding no secret value, when it cannot."""
+
 
 class SecretResolutionError(ValueError):
     """A secret reference cannot be resolved. The message never contains a secret value."""
@@ -44,12 +52,31 @@ def _from_file(path: str) -> str:
     return content.removesuffix("\n").removesuffix("\r")
 
 
-_PROVIDERS: dict[str, Callable[[str], str]] = {"env": _from_env, "file": _from_file}
+_PROVIDERS: dict[str, SecretProvider] = {"env": _from_env, "file": _from_file}
+_BUILT_IN = frozenset(_PROVIDERS)
 
 _known_values: set[str] = set()
 _lock = threading.Lock()
 
 
+def register_secret_provider(name: str, provider: SecretProvider, *, replace: bool = False) -> None:
+    """Resolve `secret://<name>/TARGET` references with `provider`.
+
+    `name` takes lowercase letters, digits, `_` and `-`. The built-in `env` and `file` cannot
+    be replaced; registering a name twice raises `ValueError` unless `replace` is true.
+    """
+    if not _PROVIDER_NAME.match(name):
+        raise ValueError(f"invalid secret provider name {name!r}; use [a-z0-9_-]+")
+    if not callable(provider):
+        raise TypeError("a secret provider must be callable")
+    if name in _BUILT_IN:
+        raise ValueError(f"the built-in secret provider {name!r} cannot be replaced")
+    with _lock:
+        if name in _PROVIDERS and not replace:
+            raise ValueError(f"secret provider {name!r} is already registered")
+        _PROVIDERS[name] = provider
+
+
 def register_secret_value(value: str) -> None:
     """Remember a secret value so log redaction can mask it."""
     if value:

{lorebase_platform-0.2.3 → lorebase_platform-0.3.1}/tests/test_secrets.py

@@ -5,9 +5,11 @@ from pathlib import Path
 import pytest
 from pydantic import SecretStr
 
+from lorebase_platform import secrets
 from lorebase_platform.secrets import (
     SecretResolutionError,
     SecretValue,
+    register_secret_provider,
     registered_secret_values,
     resolve_secret,
 )
@@ -101,3 +103,44 @@ def test_errors_never_contain_secret_values(monkeypatch: pytest.MonkeyPatch) ->
     with pytest.raises(ConfigError) as caught:
         load_settings()
     assert "super-secret-literal" not in str(caught.value)
+
+
+@pytest.fixture
+def providers(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Providers registered by a test are forgotten afterwards."""
+    monkeypatch.setattr(secrets, "_PROVIDERS", dict(secrets._PROVIDERS))
+
+
+@pytest.mark.usefixtures("providers")
+def test_a_registered_provider_resolves_its_references() -> None:
+    vault = {"db/password": "vault-s3cr3t"}
+
+    def lookup(target: str) -> str:
+        if target not in vault:
+            raise SecretResolutionError(f"no secret at {target!r}")
+        return vault[target]
+
+    register_secret_provider("vault", lookup)
+    assert resolve_secret("secret://vault/db/password") == "vault-s3cr3t"
+    assert "vault-s3cr3t" in registered_secret_values()
+    with pytest.raises(SecretResolutionError, match="no secret at 'missing'"):
+        resolve_secret("secret://vault/missing")
+
+
+@pytest.mark.usefixtures("providers")
+def test_providers_are_not_replaced_silently() -> None:
+    register_secret_provider("vault", lambda target: "first")
+    with pytest.raises(ValueError, match="already registered"):
+        register_secret_provider("vault", lambda target: "second")
+    register_secret_provider("vault", lambda target: "second", replace=True)
+    assert resolve_secret("secret://vault/x") == "second"
+    for built_in in ("env", "file"):
+        with pytest.raises(ValueError, match="cannot be replaced"):
+            register_secret_provider(built_in, lambda target: "x", replace=True)
+
+
+@pytest.mark.usefixtures("providers")
+@pytest.mark.parametrize("name", ["", "Vault", "my vault", "a/b", "vault:"])
+def test_provider_names_must_be_usable_in_references(name: str) -> None:
+    with pytest.raises(ValueError, match="invalid secret provider name"):
+        register_secret_provider(name, lambda target: "x")

lorebase_platform-0.2.3/PKG-INFO

@@ -1,11 +0,0 @@
-Metadata-Version: 2.5
-Name: lorebase-platform
-Version: 0.2.3
-Summary: Lorebase platform: settings, secrets, logging and telemetry
-Requires-Python: >=3.12
-Requires-Dist: opentelemetry-api>=1.25
-Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.25
-Requires-Dist: opentelemetry-sdk>=1.25
-Requires-Dist: pydantic-settings>=2.3
-Requires-Dist: pydantic>=2.7
-Requires-Dist: pyyaml>=6.0

lorebase_platform-0.2.3/pyproject.toml

@@ -1,13 +0,0 @@
-[project]
-name = "lorebase-platform"
-version = "0.2.3"
-description = "Lorebase platform: settings, secrets, logging and telemetry"
-requires-python = ">=3.12"
-dependencies = ["pydantic>=2.7", "pydantic-settings>=2.3", "pyyaml>=6.0", "opentelemetry-api>=1.25", "opentelemetry-sdk>=1.25", "opentelemetry-exporter-otlp-proto-grpc>=1.25"]
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/lorebase_platform"]

lorebase_platform-0.2.3/src/lorebase_platform/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.3"