sergent-py-core 0.1.0__tar.gz

sergent_py_core-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+AGENTS.md
+.codex/
+.tmp/
+.venv/
+.env
+*.ignored
+*.ignore
+
+# knowledge curation infra
+**/synopsis.xml
+
+# workflow artifacts
+HANDOFF*.md
+
+# python
+.ruff_cache/
+.pytest_cache/
+__pycache__/
+*.egg-info/
+build/
+dist/

sergent_py_core-0.1.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] [Sergent Pty Ltd]
+
+   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.

sergent_py_core-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: sergent-py-core
+Version: 0.1.0
+Summary: Sergent Python reference implementation: specification values and the ModelClient, SceneActions, and SergentRecipe interfaces
+Project-URL: Homepage, https://github.com/sergentbuild/sergent-py
+Project-URL: Documentation, https://github.com/sergentbuild/sergent-py/blob/v0.1.0/docs/KNOWLEDGE.md
+Project-URL: Repository, https://github.com/sergentbuild/sergent-py
+Project-URL: Issues, https://github.com/sergentbuild/sergent-py/issues
+Author-email: Sergent Pty Ltd <info@sergent.build>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,agentic,interfaces,llm,pydantic,sergent,specification
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pydantic :: 2
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: pydantic<3,>=2.13.5
+Requires-Dist: typing-extensions<5,>=4.16.0
+Description-Content-Type: text/markdown
+
+# sergent-py-core
+
+`sergent-py-core` is the foundation package of the Sergent Python reference implementation. It
+holds the values that the [Sergent Specification](https://github.com/sergentbuild/sergent-py/blob/v0.1.0/sergent/docs/KNOWLEDGE.md) names, plus the
+three interfaces an application implements or supplies. It executes nothing: no Run flow, no event
+loop, no provider call, no file access.
+
+## Purpose and role
+
+A Sergent Run carries one observation toward one committed change through a fixed sequence of
+stages. Core does not perform that sequence. It names the value each stage carries and the
+interface each participant implements, so every package above it shares one vocabulary instead of
+agreeing on one informally.
+
+Core sits at the bottom of a four-package stack and depends on nothing else inside it. Its only
+outside dependencies are Pydantic, typing-extensions, and the Python standard library.
+
+- `sergent-py-runtime` composes these values into the Run flow, builds the Run Record, and delivers
+  observer callbacks.
+- `sergent-py-providers` implements the model-call interface. It consumes only the model-call
+  values and the shared primitives, and core knows nothing about any provider SDK.
+- `sergent-py` re-exports the curated subset that applications import.
+
+Applications import from `sergent_py` only. Framework packages and tests import the defining core
+submodule directly, because every package initializer here is an empty marker and importing a
+submodule has no side effects.
+
+Core is not the specification. The specification teaches the concepts and owns their rules. This
+package materializes them as Python objects and holds nothing conceptual of its own.
+
+## Design philosophy and what belongs here
+
+Core is a **vocabulary**, not a coordinator. A class earns its place by naming one specification
+concept and owning the facts that concept owns. Four habits keep it that way.
+
+- **Closed-world data.** Values reject unknown input and fail at construction, so a value admitted
+  once at its boundary is trusted everywhere afterwards, as the
+  [trust rule](https://github.com/sergentbuild/sergent-py/blob/v0.1.0/sergent/docs/trust-boundaries.md#the-trust-rule) requires.
+- **One owner per fact.** Facts that always travel together live in one value object that every
+  holder shares. Nothing stores what it can derive.
+- **Specification terminology decides names.** A class is named after the concept it materializes,
+  never after the mechanism it happens to use.
+- **Immutability where authority is at stake.** Script steps are frozen, and a value carrying
+  cross-field rules is replaced whole rather than edited in place.
+
+Code that belongs here: specification-shaped values, the framework identifier and timing
+conventions, canonical Proposal Schema derivation with its closed dialect check, the Operation
+Registry, and the three interfaces.
+
+Code that does not belong here: the Run flow and its stages, concurrency and cancellation
+machinery, observer delivery, persistence, provider transport and credentials, application policy,
+and default wiring. Intent and Intent Proposal classes are absent by design. An application owns
+its own, and the runtime owns its deterministic variants.
+
+## Knowledge in this package
+
+- [Component knowledge](https://github.com/sergentbuild/sergent-py/blob/v0.1.0/sergent-py-core/docs/KNOWLEDGE.md) explains the design, then walks subject by subject from
+  specification concept to Python shape.
+- [Core class design pattern](https://github.com/sergentbuild/sergent-py/blob/v0.1.0/sergent-py-core/docs/core-class-design-pattern.md) is the standing rulebook for
+  adding or changing a class or a field here.

sergent_py_core-0.1.0/README.md

@@ -0,0 +1,60 @@
+# sergent-py-core
+
+`sergent-py-core` is the foundation package of the Sergent Python reference implementation. It
+holds the values that the [Sergent Specification](../sergent/docs/KNOWLEDGE.md) names, plus the
+three interfaces an application implements or supplies. It executes nothing: no Run flow, no event
+loop, no provider call, no file access.
+
+## Purpose and role
+
+A Sergent Run carries one observation toward one committed change through a fixed sequence of
+stages. Core does not perform that sequence. It names the value each stage carries and the
+interface each participant implements, so every package above it shares one vocabulary instead of
+agreeing on one informally.
+
+Core sits at the bottom of a four-package stack and depends on nothing else inside it. Its only
+outside dependencies are Pydantic, typing-extensions, and the Python standard library.
+
+- `sergent-py-runtime` composes these values into the Run flow, builds the Run Record, and delivers
+  observer callbacks.
+- `sergent-py-providers` implements the model-call interface. It consumes only the model-call
+  values and the shared primitives, and core knows nothing about any provider SDK.
+- `sergent-py` re-exports the curated subset that applications import.
+
+Applications import from `sergent_py` only. Framework packages and tests import the defining core
+submodule directly, because every package initializer here is an empty marker and importing a
+submodule has no side effects.
+
+Core is not the specification. The specification teaches the concepts and owns their rules. This
+package materializes them as Python objects and holds nothing conceptual of its own.
+
+## Design philosophy and what belongs here
+
+Core is a **vocabulary**, not a coordinator. A class earns its place by naming one specification
+concept and owning the facts that concept owns. Four habits keep it that way.
+
+- **Closed-world data.** Values reject unknown input and fail at construction, so a value admitted
+  once at its boundary is trusted everywhere afterwards, as the
+  [trust rule](../sergent/docs/trust-boundaries.md#the-trust-rule) requires.
+- **One owner per fact.** Facts that always travel together live in one value object that every
+  holder shares. Nothing stores what it can derive.
+- **Specification terminology decides names.** A class is named after the concept it materializes,
+  never after the mechanism it happens to use.
+- **Immutability where authority is at stake.** Script steps are frozen, and a value carrying
+  cross-field rules is replaced whole rather than edited in place.
+
+Code that belongs here: specification-shaped values, the framework identifier and timing
+conventions, canonical Proposal Schema derivation with its closed dialect check, the Operation
+Registry, and the three interfaces.
+
+Code that does not belong here: the Run flow and its stages, concurrency and cancellation
+machinery, observer delivery, persistence, provider transport and credentials, application policy,
+and default wiring. Intent and Intent Proposal classes are absent by design. An application owns
+its own, and the runtime owns its deterministic variants.
+
+## Knowledge in this package
+
+- [Component knowledge](docs/KNOWLEDGE.md) explains the design, then walks subject by subject from
+  specification concept to Python shape.
+- [Core class design pattern](docs/core-class-design-pattern.md) is the standing rulebook for
+  adding or changing a class or a field here.

sergent_py_core-0.1.0/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["hatchling>=1.32.0,<2", "hatch-fancy-pypi-readme>=25.1.0,<26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sergent-py-core"
+version = "0.1.0"
+description = "Sergent Python reference implementation: specification values and the ModelClient, SceneActions, and SergentRecipe interfaces"
+dynamic = ["readme"]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Sergent Pty Ltd", email = "info@sergent.build" }]
+requires-python = ">=3.11"
+keywords = [
+    "sergent",
+    "agentic",
+    "agent",
+    "llm",
+    "specification",
+    "interfaces",
+    "pydantic",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: Pydantic :: 2",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "pydantic>=2.13.5,<3",
+    "typing-extensions>=4.16.0,<5",
+]
+
+[project.urls]
+Homepage = "https://github.com/sergentbuild/sergent-py"
+Documentation = "https://github.com/sergentbuild/sergent-py/blob/v0.1.0/docs/KNOWLEDGE.md"
+Repository = "https://github.com/sergentbuild/sergent-py"
+Issues = "https://github.com/sergentbuild/sergent-py/issues"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+fragments = [{ path = "README.md" }]
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '(\]\()\.\./'
+replacement = '\1https://github.com/sergentbuild/sergent-py/blob/v$HFPR_VERSION/'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '(\]\()docs/'
+replacement = '\1https://github.com/sergentbuild/sergent-py/blob/v$HFPR_VERSION/$HFPR_PACKAGE_NAME/docs/'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sergent_py_core"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/sergent_py_core", "README.md"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

sergent_py_core-0.1.0/src/sergent_py_core/errors.py

@@ -0,0 +1,15 @@
+"""Define the structured failure value shared across a Run. @sergent/docs/execution-model.md"""
+
+from __future__ import annotations
+
+import pydantic
+
+import sergent_py_core.strict_model as strict_model
+
+
+class RunError(strict_model.StrictModel):
+    """Carry a bounded structured failure without raising across the runtime. @sergent/docs/execution-model.md"""
+
+    kind: str
+    message: str
+    metadata: dict[str, object] = pydantic.Field(default_factory=dict)

sergent_py_core-0.1.0/src/sergent_py_core/identifiers.py

@@ -0,0 +1,32 @@
+"""Mint and admit framework-owned bookkeeping identifiers. @sergent/docs/execution-model.md"""
+
+from __future__ import annotations
+
+import re
+import uuid
+
+_ID_RE = re.compile(r"^([a-z][a-z0-9]*)_[0-9a-f]{32}$")
+_PREFIX_RE = re.compile(r"^[a-z][a-z0-9]*$")
+
+
+def new_id(prefix: str) -> str:
+    """Mint a framework identifier with a validated prefix. @sergent/docs/execution-model.md"""
+    if _PREFIX_RE.fullmatch(prefix) is None:
+        msg = f"invalid id prefix: {prefix!r}"
+        raise ValueError(msg)
+    return f"{prefix}_{uuid.uuid4().hex}"
+
+
+def checked_id(value: str, *prefixes: str) -> str:
+    """Admit a framework identifier, optionally from bounded prefixes. @sergent/docs/execution-model.md"""
+    match = _ID_RE.fullmatch(value) if isinstance(value, str) else None
+    if match is None:
+        msg = "id must match '<prefix>_<32 lowercase hex chars>'"
+        raise ValueError(msg)
+    if not prefixes:
+        return value
+    if match.group(1) not in set(prefixes):
+        expected = ", ".join(sorted(prefixes))
+        msg = f"id prefix must be one of: {expected}"
+        raise ValueError(msg)
+    return value

sergent_py_core-0.1.0/src/sergent_py_core/intent.py

@@ -0,0 +1,46 @@
+"""Read Intent flow control and stop terminal facts. @sergent/docs/framework.md"""
+
+from __future__ import annotations
+
+import typing
+
+
+def intent_flow(intent: object) -> typing.Literal["continue", "stop"]:
+    """Read bounded flow control, defaulting an absent fact to continue. @sergent/docs/framework.md"""
+    flow = getattr(intent, "flow", "continue")
+    if flow not in {"continue", "stop"}:
+        msg = f"unsupported intent flow: {flow!r}"
+        raise ValueError(msg)
+    return typing.cast(typing.Literal["continue", "stop"], flow)
+
+
+def intent_terminal_message(intent: object) -> str | None:
+    """Read an optional terminal message from a stop Intent. @sergent/docs/framework.md"""
+    terminal_message = getattr(intent, "terminal_message", None)
+    if terminal_message is None:
+        return None
+    if not callable(terminal_message):
+        msg = "intent terminal_message must be callable"
+        raise ValueError(msg)
+    message = terminal_message()
+    if message is None:
+        return None
+    if not isinstance(message, str):
+        msg = "intent terminal_message must return a str"
+        raise ValueError(msg)
+    return message
+
+
+def intent_terminal_metadata(intent: object) -> dict[str, object]:
+    """Read terminal metadata from a stop Intent. @sergent/docs/framework.md"""
+    terminal_metadata = getattr(intent, "terminal_metadata", None)
+    if terminal_metadata is None:
+        return {}
+    if not callable(terminal_metadata):
+        msg = "intent terminal_metadata must be callable"
+        raise ValueError(msg)
+    metadata = terminal_metadata()
+    if not isinstance(metadata, dict):
+        msg = "intent terminal_metadata must return a dict"
+        raise ValueError(msg)
+    return dict(metadata)

sergent_py_core-0.1.0/src/sergent_py_core/mindbuf.py

@@ -0,0 +1,11 @@
+"""Define the MindBuf observation channel supplied to each run. @sergent/docs/framework.md"""
+
+from __future__ import annotations
+
+
+class MindBuf:
+    """Render context-ready out-of-Scene observation text. @sergent/docs/framework.md"""
+
+    def export(self) -> str:
+        """Return context-ready observation text without mutation. @sergent/docs/framework.md"""
+        return ""