mercury-composable 4.12.1__tar.gz

mercury_composable-4.12.1/.gitignore

@@ -0,0 +1,48 @@
+__pycache__/
+*.pyc
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+uv.lock
+.idea/
+.DS_Store
+
+# === agent-memory: AI infrastructure (personal / per-machine — do not commit) ===
+# Steering files (CLAUDE.md, GEMINI.md, AGENTS.md, .cursorrules, .windsurfrules,
+# .github/copilot-instructions.md), the shared memory layer (memory/, .agent/,
+# legacy/), and the shared skills layer (agent-skills/) are intentionally TRACKED — they
+# are committed and shared across the team, so do NOT ignore them. Only personal
+# AI-IDE runtime directories and local history/caches are ignored below (the
+# "infrastructure", not the steering). The vendor dirs below also hold per-machine
+# skill *adapters* (.claude/skills/, .gemini/commands/, .cursor/rules/, .kiro/skills/,
+# .github/skills/, .agents/skills/) regenerated from agent-skills/ — local only; the neutral
+# agent-skills/ is the shared source of truth. NOTE: GitHub Copilot's skill adapter lives at
+# .github/skills/, so it is ignored path-scoped (below) — never ignore all of .github/, which holds
+# the tracked copilot-instructions.md and workflows/. .agents/skills/ is the Agent Skills standard dir
+# read by Google Antigravity (agy, the Gemini CLI successor — it ignores .gemini/commands).
+.kiro/
+.claude/
+.cursor/
+.continue/
+.windsurf/
+.codeium/
+.gemini/
+.github/skills/
+.agents/
+.cline/
+.roo/
+.zed/
+.codex/
+.aider.chat.history.md
+.aider.input.history
+.aider.tags.cache*
+review-scratch/
+*.py[cod]
+
+# mkdocs build output
+site/

mercury_composable-4.12.1/CHANGELOG.md

@@ -0,0 +1,142 @@
+# Changelog
+
+## Version 4.12.1, 9/1/2026
+
+The first PyPI release: `pip install mercury-composable`. The v4.12.0 lock-step line
+plus the AI-node demo functions below.
+
+### Added
+
+- `llm.chat` demo function (examples/demo_app.py) - the AI node of the agent-orchestration
+  experiment E0: a provider-neutral LLM adapter (Anthropic and Gemini backends behind one
+  contract; select with `llm.provider` config / `-Dllm.provider=...` / `params.provider`)
+  with structured output (`schema` -> JSON verdicts for graph decision routing;
+  additionalProperties defaults closed), usage/stop_reason surfacing, provider-error
+  mapping onto the envelope status, and the params.timeout_ms time-budget mapping.
+  The SDKs are an optional extra (`pip install "mercury-composable[llm]"`); the package
+  itself stays SDK-free (scope fence intact).
+- `llm.stream` demo function - the STREAMING AI node: pulls the provider's real token
+  stream (Anthropic `messages.stream` or Gemini `generate_content_stream`) and relays
+  each token batch over the multi-shot reply contract, so a calling engine renders it
+  progressively out its own HTTP edge as SSE. Terminal metadata carries model,
+  stop_reason, usage and the trace/business correlation ids; provider errors fail the
+  stream in-band. Live-proven end to end with real Gemini tokens (2026-08-31).
+- PyPI publication metadata: SPDX license expression (PEP 639), trove classifiers,
+  keywords, project URLs, and a constrained sdist (package sources, tests, examples
+  and top-level docs only - repo-internal layers never ship).
+
+## 4.12.0 (2026-08-30)
+
+The progressive-rendering milestone release. The version aligns with the Mercury
+Composable engine lock-step line (Java and Rust engines, Python and Node.js
+language packs all at v4.12.0): token/event streaming end to end with full
+OpenTelemetry lineage, business-correlation continuity and application log
+context across all four runtimes - useful on its own, and the foundation for
+the AI SDLC (agent, MCP and tool adapters as wrapper-side functions with
+complete observability).
+
+- **Event streaming** - the platform-wide multi-shot reply contract, both halves.
+  Producer: `@preload(..., interceptor=True)` handlers receive the raw envelope
+  and stream through `EventStreamWriter` (the engines' exact API - `first`,
+  `write`, `write_named`, `close` with trailing metadata, `fail` with the standard
+  error key-values); the `/api/event` host answers a caller that accepts
+  `text/event-stream` with the platform's hybrid SSE dialect (envelope frames for
+  the head, the terminals and non-text segments; raw frames for text tokens),
+  refuses a non-accepting caller of a streaming function with the pinned 406, and
+  keeps single-shot replies over the capable path byte-identical. Consumer:
+  `PostOffice.stream()` (an async iterator yielding the same decoded envelopes an
+  engine reply route receives, with the dialect conformance guards) and
+  `PostOffice.stream_to()` (the relay form: forward your caller's reply address
+  and segments flow through verbatim - engine-parity composition). Under it all,
+  the primitive event bus gained the engines' reply_to mechanism: envelope-routed
+  delivery to a LOCAL function or per-request reply sink - simple routing, no
+  orchestration. Same keep-alive config key as the engines
+  (`event.stream.keep.alive`). Engine-identical wire and messages
+  (Java PR #299-#301 / Rust PR #216-#218 lineage).
+- **Business correlation-id continuity** (the engines' PostOffice parity): the
+  client stamps the current context's business correlation-id onto outbound
+  events as the engine-managed `my_cid` tag, local bus deliveries inject the
+  read-only `my_correlation_id` header view exactly like the HTTP host, and
+  `get_trace()` / `trace_context()` carry `my_correlation_id` - so the business
+  correlation-id continues across engine⇄wrapper and wrapper⇄wrapper hops.
+- **Span lineage** (the engines' telemetry model): every traced execution mints
+  a 16-hex span with the caller's span (from the inbound envelope) as its
+  parent, outbound events carry the current span so the next hop parents onto
+  it (`PostOffice.touch` parity, W3C `traceparent` included), streaming
+  segments carry the producer's span, and non-RPC executions emit the engines'
+  distributed-trace dataset record on the `distributed.tracing` log stream -
+  the same `{"trace": {...}, "annotations": {...}}` shape the Java engine
+  logs, so stdout log-ingest agents stitch spans across all four runtimes.
+  RPC round-trips are suppressed exactly like the engines (the new `rpc`
+  envelope tag rides `request()` calls). `trace_context()` accepts `span_id`
+  to parent onto an external OpenTelemetry span. Outbound events and stream
+  segments also fill their sender with the executing function's route, and
+  the `/api/event` host fills `event.api.service` for an anonymous caller -
+  the engines' sender-attribution rules.
+- **Application log context** (the engines' app-log-context feature, on by
+  default via the packaged `default-log-context.yaml` - the engines' resource
+  twin): with `log.format` json/compact, every log line inside a traced
+  request carries a `context` block - cid (the business correlation-id),
+  traceId, tracePath, spanId, parentSpanId, service, timestamp - so app logs
+  and the distributed-trace records correlate end to end. Customize with
+  `resources/app-log-context.yaml` (reserved `$tokens` or constants with
+  `${ENV:default}`), opt out with `app.log.context=false`, and add
+  per-request key-values with `update_context()` (reserved keys guarded).
+- Documentation site (mkdocs-material, the engine repo's theme): the three-layer theme
+  reference, rationale/design foundations, function-writing patterns, flow and
+  knowledge-graph join chapters, a one-page AI agent guide with llms.txt, and
+  configuration/HTTP references - published to
+  https://accenture.github.io/mercury-python/ by the new CI workflow, which also runs
+  the three quality gates (pytest, ruff, basedpyright) on every push and pull request.
+- Host polish for engine parity: `GET /` serves the engines' minimal index page linking
+  the actuator endpoints (embedded - no static file service by design); actuator JSON
+  responses are pretty-printed (the engines' default-serializer presentation); unknown
+  paths and non-GET methods answer the engines' error shape
+  `{"status": 404, "message": "Resource not found", "type": "error"}`.
+- Sync bridge: `PostOffice.request_sync()` / `send_sync()` let a plain `def` handler
+  (the synchronous ecosystem - `requests`, NumPy/ML inference, database drivers) call
+  sibling or remote functions - the call runs on the host event loop while only the
+  handler's worker thread blocks; the trace chain rides across unbroken. Calling the
+  bridge from async code, or outside a hosted function, is refused with a teaching
+  error. The sync-vs-async handler rationale is now documented (README and the
+  registry module).
+- Actuator endpoints `/info`, `/info/routes`, `/env`, `/health` and `/livenessprobe` -
+  the engines' operational surface, for Kubernetes probes and one-dashboard monitoring
+  of polyglot installations. Health check functions are normal registered functions
+  speaking the engines' `type=info` / `type=health` interface contract, listed in
+  `mandatory.health.dependencies` / `optional.health.dependencies` and called through
+  the event bus. `/health` answers `UP` (200) / `DOWN` (400); `/livenessprobe` follows
+  the most recent health outcome.
+- `log.format` carries the engines' three presentations: `text` (default), `json`
+  (pretty-printed) and `compact` (single-line JSONL for log aggregators). A sample
+  `examples/resources/application.yml` demonstrates the resources convention and the
+  well-known keys.
+- Primitive in-process event bus - the single dispatch pipeline: one FIFO mailbox per
+  route consumed by `instances` worker tasks (the parameter is faithful); RPC deliveries
+  are ttl-bounded with a dead-work skip; drop-n-forget returns the 202-shape ack. The
+  HTTP host and the local side of PostOffice are thin ingress adapters over it. No spill
+  tier and no queue cap by design - back-pressure belongs to the engines' flows/graphs;
+  a leaf host fails fast by deadline.
+- PostOffice without an endpoint delivers locally (engine semantics): private routes are
+  callable in-app while the wire keeps its 403; headers pass verbatim; the reply envelope
+  shape is identical to the remote path.
+
+Repository repurposed for the Mercury Composable **polyglot initiative** (August 2026).
+
+- Lightweight Event-over-HTTP function host (`POST /api/event`) mirroring the engines'
+  EventApiService semantics (x-ttl execution bound, x-async drop-n-forget with 202 ack,
+  reserved header hygiene, `my_cid` → `my_correlation_id` injection, portable error
+  contract, engine-identical error messages).
+- Standard event envelope wire format codec, verified against the golden conformance
+  vectors shared with the Java and Rust engines; compact format detected and rejected.
+- `@preload` function registry with instance-count concurrency limits and private routes.
+- `PostOffice` thin client with the engines' relay HTTP contract (octet-stream, x-ttl,
+  x-no-stream, trace headers) for calling engine or peer polyglot functions.
+- Minimalist utilities in engine-consistent style: `AppConfig` (`${ENV:default}`
+  substitution, runtime overrides), logging in the reference log4j2 presentation
+  (`log.format=text|json`, `LOG_LEVEL`), and distributed-trace context with reply
+  annotations.
+- `mercury-serve` developer runner.
+
+The legacy Mercury language-pack implementation (pre-composable, websocket-based) remains
+available in the git history prior to this version.

mercury_composable-4.12.1/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 2018-2026 Accenture.
+
+   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.

mercury_composable-4.12.1/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.5
+Name: mercury-composable
+Version: 4.12.1
+Summary: Lightweight Event-over-HTTP function host and client for Mercury Composable
+Project-URL: Homepage, https://github.com/Accenture/mercury-python
+Project-URL: Documentation, https://accenture.github.io/mercury-python
+Project-URL: Repository, https://github.com/Accenture/mercury-python
+Project-URL: Changelog, https://github.com/Accenture/mercury-python/blob/main/CHANGELOG.md
+Author: Accenture Technology
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: composable,event-driven,event-over-http,mercury,microservices
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: aiohttp<4,>=3.10
+Requires-Dist: msgpack<2,>=1.0
+Requires-Dist: pyyaml<7,>=6.0
+Provides-Extra: dev
+Requires-Dist: anthropic<2,>=1; extra == 'dev'
+Requires-Dist: google-genai<3,>=2; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Provides-Extra: llm
+Requires-Dist: anthropic<2,>=1; extra == 'llm'
+Requires-Dist: google-genai<3,>=2; extra == 'llm'
+Description-Content-Type: text/markdown
+
+# Mercury Composable — polyglot functions for Python
+
+Write decoupled functions in Python and let [Mercury Composable](https://github.com/Accenture/mercury-composable)
+engines (Java, and the official [Rust port](https://github.com/Accenture/mercury)) orchestrate
+them from Event Script flows and MiniGraph knowledge graphs — with no orchestration code in
+Python at all.
+
+This package is a deliberately **lightweight wrapper of the Event-over-HTTP protocol**:
+
+- an **Event API host** (`POST /api/event`) that dispatches incoming event envelopes to your
+  registered functions,
+- a **thin client** (`PostOffice`) to call functions on peer applications the same way,
+- the **standard event envelope wire format** codec (language-neutral MsgPack), and
+- a **primitive in-process event bus** — the single dispatch pipeline: one FIFO mailbox
+  per route consumed by `instances` worker tasks, and
+- the **minimalist utilities** shared with the engines for consistency: configuration
+  management, logging in the engines' presentation format, and distributed-trace context.
+
+Orchestration deliberately stays in the engines. Functions written here are addressed by
+route name through the engines' declarative `yaml.event.over.http` map, so a flow or a
+graph task calls a Python function exactly as if it were local.
+
+**Documentation:** <https://accenture.github.io/mercury-python/> — including the
+[AI Agent Guide](https://accenture.github.io/mercury-python/guides/ai-agent-guide/)
+for deterministic function generation.
+
+> **Status: pre-release.** This repository was repurposed in August 2026 for the polyglot
+> initiative. The legacy Mercury language-pack implementation remains available in the git
+> history.
+
+## Quick start
+
+```python
+# app.py
+from mercury_composable import AppException, Body, platform, preload
+
+@preload(route="hello.python", instances=10)
+def handle_event(headers: dict[str, str], body: Body):
+    if not isinstance(body, dict) or "text" not in body:
+        raise AppException(400, "missing 'text'")
+    return {"text": str(body["text"]).upper(), "language": "python"}
+
+if __name__ == "__main__":
+    platform.run()   # port from rest.server.port (default 8085)
+```
+
+Run it:
+
+```bash
+pip install -e '.[dev]'
+mercury-serve app.py -Drest.server.port=8086
+```
+
+Call it from a Mercury engine application with two configuration entries and no code —
+`application.properties`:
+
+```properties
+yaml.event.over.http=classpath:/event-over-http.yaml
+```
+
+`event-over-http.yaml`:
+
+```yaml
+event.http:
+  - route: 'hello.python'
+    target: 'http://127.0.0.1:8086/api/event'
+```
+
+Any Event Script task or MiniGraph `graph.task` node that names the route `hello.python`
+now executes the Python function, with trace context carried end to end.
+
+## The function contract
+
+A handler receives the same two-part input as an engine `TypedLambdaFunction` —
+`(headers: dict[str, str], body: Body)` — `Body` is any MsgPack value — and returns the reply body (or an `EventEnvelope` for full
+control of status and reply headers). **Both `async def` and plain `def` handlers are
+first-class**, because Python has two library ecosystems and a polyglot function must be
+able to wrap either:
+
+- **plain `def`** — for the synchronous world: `requests` (one of the most popular HTTP
+  clients), NumPy/pandas and most ML inference stacks, database drivers. These handlers
+  run in a thread-pool executor, so a blocking call can never stall the event loop that
+  hosts every other function. This is the Python analog of the Java engine's virtual
+  threads: write sequential blocking-style code and the platform makes it safe.
+- **`async def`** — for asyncio-native I/O and for composing sibling functions with
+  `await po.request(...)`.
+
+The style is detected automatically (no flag to set), and trace context, `instances`,
+envelopes and telemetry behave identically in both. Rule of thumb: wrapping a blocking
+library → plain `def`; composing functions or async I/O → `async def`.
+
+- Raise `AppException(status, message)` for intentional errors — it becomes the portable
+  error contract on the wire (envelope status + message), handled by the calling flow's
+  exception handler or the graph's `error.*` contract.
+- `get_trace()` exposes `trace_id` / `trace_path` / `cid`; `annotate_trace(k, v)` sends an
+  annotation back on the reply envelope.
+- Outside a hosted function (batch jobs, tests), `trace_context(trace_id, trace_path)`
+  establishes the context your `PostOffice` calls inherit — the node `runWithTrace` twin.
+- Functions must be stateless; anything you must keep belongs to the caller's flow model
+  or state machine.
+
+### Local function calls
+
+`PostOffice` **without an endpoint** delivers through this application's own event bus —
+the engines' semantics for an in-app `po` call:
+
+- `private=True` means exactly what it means in the engines: callable **in-app only**.
+  Local calls reach private and public routes alike; the HTTP host keeps answering 403
+  for private targets from the wire.
+- `instances` is faithful: each route has one FIFO mailbox consumed by that many worker
+  tasks. RPC waits are bounded by `timeout_ms` (the standard 408 envelope on breach), and
+  a queued call whose caller already timed out is skipped, never wastefully executed.
+- **Sync handlers compose too**: `po.request_sync(...)` / `po.send_sync(...)` run the
+  same call on the host loop while blocking only the handler's own worker thread — the
+  trace chain rides across the bridge unbroken. Calling the sync bridge from async code
+  is refused with a teaching error (`await po.request(...)` is the async way), and using
+  it outside a hosted function tells you to use `asyncio.run(po.request(...))` instead.
+- There is **no spill tier and no queue cap** by design: back-pressure belongs to the tier
+  that owns recovery — the engines' flows and graphs. A leaf host fails fast by deadline
+  instead of hoarding work.
+
+Local eventing is for simple leaf-side composition. Workflow processing belongs in Event
+Script and Knowledge Graph on the engines — that boundary is the architecture.
+
+## Configuration, logging, telemetry
+
+The same conventions as the engines, so a polyglot installation stays uniform:
+
+| Key | Meaning | Default |
+|-----|---------|---------|
+| `application.name` | application identity in logs | `application` |
+| `rest.server.port` | Event API port | `8085` |
+| `log.format` | `text`, `json` (pretty-printed) or `compact` (single-line JSONL) | `text` |
+| `log.level` | log level (`LOG_LEVEL` env var wins) | `INFO` |
+
+Configuration lives in the `resources` folder, mirroring the engines:
+`resources/application.yml` (or `.yaml` / `.properties`) in the working directory or next
+to the application file, or an explicit `--config` path — see
+[`examples/resources/application.yml`](examples/resources/application.yml) for a worked
+sample. Values support `${ENV_VAR:default}` substitution. Runtime parameter overrides use the
+same `-D` syntax as the Java engine and the Rust port — checked first on every read
+(`AppConfig.set(key, value)` does the same programmatically, the `f:setConfig` analog):
+
+```bash
+mercury-serve app.py -Drest.server.port=8086 -Dlog.format=json
+```
+
+Log lines follow the Java reference engine's pattern for one-aggregation consistency:
+
+```text
+2026-08-22 10:15:30.123 INFO  my_app:42 - Loaded PUBLIC hello.python, instances=10
+```
+
+## Actuator endpoints
+
+The host serves the engines' operational endpoints on the same port as `/api/event`, so
+Kubernetes probes and dashboards treat a Python app exactly like a Java or Rust engine app:
+
+| Endpoint | Purpose |
+|----------|---------|
+| `GET /` | minimal index page linking the endpoints below |
+| `GET /info` | app identity, runtime, origin id, start time, uptime |
+| `GET /info/routes` | registered routes split by visibility, with instance counts |
+| `GET /env` | selected environment variables and configuration parameters |
+| `GET /health` | dependency health checks — `UP` (HTTP 200) or `DOWN` (HTTP 400) |
+| `GET /livenessprobe` | `OK` while the last health outcome was good, else HTTP 400 |
+
+Configuration keys carry the engines' names: `info.app.version`, `info.app.description`,
+`show.env.variables` and `show.application.properties` (opt-in lists — secrets are never
+dumped wholesale), and `mandatory.health.dependencies` / `optional.health.dependencies`
+(routes of health check functions; optional ones never change the overall status). A
+health check function is a normal registered function — usually private — speaking the
+engines' interface contract, called through the event bus:
+
+```python
+@preload("demo.health", private=True)
+async def health(headers: dict[str, str], _body: Body) -> Body:
+    if headers.get("type") == "info":
+        return {"service": "demo.service", "href": "http://127.0.0.1"}
+    return "demo.service is running fine"   # a non-200 reply marks it down
+```
+
+JSON responses are pretty-printed — the engines' default-serializer presentation — and
+unknown paths answer the engines' error shape
+(`{"status": 404, "message": "Resource not found", "type": "error"}`).
+
+Kubernetes wiring: point `livenessProbe` at `/livenessprobe` and `readinessProbe` at
+`/health`.
+
+## Wire compatibility
+
+The codec implements the
+[Event Envelope Wire Format](https://accenture.github.io/mercury-composable/guides/event-envelope-wire-format/)
+(standard format) and is verified against the golden conformance vectors shared by the
+Java and Rust engines (`tests/vectors/vectors.json`). The classic compact format is
+detected and rejected with a teaching error — engines default to the standard format for
+Event over HTTP.
+
+Serialization notes: integers and floats follow MsgPack's natural widths (the same
+long/integer care as the engines applies); timestamps travel as ISO-8601 UTC strings with
+millisecond precision; binary payloads use MsgPack `bin`.
+
+## Scope
+
+This package intentionally contains **no orchestration: no flows, no graphs, no
+persistence, no pub/sub broadcast** — those live in the engines. What it does carry is
+deliberately minimal: functions, a primitive in-process event bus (route mailboxes +
+workers, RPC and drop-n-forget — nothing more), and the minimalist foundation utilities,
+keeping Python fast to prototype with while the composable core guarantees the
+architecture.
+
+## Development
+
+```bash
+uv venv .venv && uv pip install -e '.[dev]'   # environment (uv-managed python)
+.venv/bin/pytest -q                           # tests
+uvx ruff check .                              # lint (config in pyproject.toml)
+uvx basedpyright                              # type check (config in pyproject.toml)
+```
+
+PyCharm: use interpreter type **uv** pointing at the project `.venv`, and set
+*Settings → Tools → Python Integrated Tools → Package requirements file* to
+`pyproject.toml` so the requirements inspection reads `[project.dependencies]`.
+
+## License
+
+Apache 2.0 — see [LICENSE.txt](LICENSE.txt).