pulsar-fxmacrodata 0.1.0__py3-none-any.whl

fxmacrodata_pulsar/__init__.py

@@ -0,0 +1,155 @@
+"""Publish public FXMacroData responses to a customer-owned Apache Pulsar topic."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+import hashlib
+import json
+import math
+import re
+from typing import Any
+
+from fxmacrodata_platform_core import read
+
+__version__ = "0.1.0"
+
+COLUMNS = (
+    "operation", "source_url", "record_id", "currency", "indicator", "date",
+    "announcement_datetime", "value", "value_text", "record_json", "response_json",
+    "content_hash",
+)
+PROPERTIES = ("operation", "record_id", "content_hash", "source_url")
+MAX_MESSAGE_BYTES = 16 * 1024 * 1024
+_TOPIC = re.compile(
+    r"(?:(?:persistent|non-persistent)://[A-Za-z0-9_.-]{1,64}/[A-Za-z0-9_.-]{1,64}/)?[A-Za-z0-9_.-]{1,255}\Z"
+)
+
+
+class PublishError(RuntimeError):
+    """A destination publish failed; inspect the destination before retrying."""
+
+
+@dataclass(frozen=True)
+class PublishResult:
+    destination: str
+    messages: int
+    batches: int
+
+
+def _topic(destination: str, producer: Any) -> str:
+    if not isinstance(destination, str) or not _TOPIC.fullmatch(destination):
+        raise ValueError("destination must be a Pulsar topic name such as persistent://tenant/namespace/topic")
+    bound = getattr(producer, "topic", None)
+    if callable(bound):
+        try:
+            actual = bound()
+        except Exception:
+            raise ValueError("the producer did not report its topic; pass a connected pulsar.Producer") from None
+        if isinstance(actual, str) and actual != destination:
+            raise ValueError("destination does not match the producer's topic")
+    return destination
+
+
+def _bounds(batch_size: int, max_message_bytes: int) -> None:
+    if isinstance(batch_size, bool) or not isinstance(batch_size, int) or not 1 <= batch_size <= 10000:
+        raise ValueError("batch_size must be an integer between 1 and 10000")
+    if isinstance(max_message_bytes, bool) or not isinstance(max_message_bytes, int) or not 1 <= max_message_bytes <= MAX_MESSAGE_BYTES:
+        raise ValueError(f"max_message_bytes must be an integer between 1 and {MAX_MESSAGE_BYTES}")
+
+
+def _rows(batch: Any) -> list[dict[str, Any]]:
+    rows = []
+    for source in batch.rows():
+        row = {name: source.get(name) for name in COLUMNS[:-1]}
+        if not isinstance(row["operation"], str) or not isinstance(row["record_id"], str):
+            raise ValueError("every row requires string operation and record_id")
+        for name, value in row.items():
+            if name == "value":
+                if value is not None and (
+                    isinstance(value, bool) or not isinstance(value, (int, float)) or
+                    not math.isfinite(value)
+                ):
+                    raise ValueError("value must be a finite number or null")
+            elif value is not None and not isinstance(value, str):
+                raise ValueError(f"{name} must be a string or null")
+        encoded = json.dumps(row, sort_keys=True, separators=(",", ":"), ensure_ascii=False)
+        row["content_hash"] = hashlib.sha256(encoded.encode("utf-8")).hexdigest()
+        rows.append(row)
+    return rows
+
+
+def message_key(row: dict[str, Any]) -> str:
+    """Return the idempotency key used as the Pulsar partition key."""
+    return f"{row['operation']}:{row['record_id']}:{row['content_hash']}"
+
+
+def encode_message(row: dict[str, Any]) -> bytes:
+    """Return the canonical UTF-8 JSON body for one envelope row."""
+    return json.dumps(row, sort_keys=True, separators=(",", ":"), ensure_ascii=False,
+                      allow_nan=False).encode("utf-8")
+
+
+def _properties(row: dict[str, Any]) -> dict[str, str]:
+    return {name: row[name] for name in PROPERTIES if row.get(name) is not None}
+
+
+def _blocks(rows: list[dict[str, Any]], batch_size: int,
+            max_message_bytes: int) -> list[list[tuple[str, bytes, dict[str, str]]]]:
+    output: list[list[tuple[str, bytes, dict[str, str]]]] = []
+    block: list[tuple[str, bytes, dict[str, str]]] = []
+    for row in rows:
+        body = encode_message(row)
+        if len(body) > max_message_bytes:
+            raise ValueError("one envelope exceeds max_message_bytes; narrow the source date range")
+        if len(block) >= batch_size:
+            output.append(block)
+            block = []
+        block.append((message_key(row), body, _properties(row)))
+    if block:
+        output.append(block)
+    return output
+
+
+def publish(batch: Any, producer: Any, destination: str, *, batch_size: int = 1000,
+            max_message_bytes: int = MAX_MESSAGE_BYTES) -> PublishResult:
+    """Send one message per envelope row through Producer.send and wait for each acknowledgement.
+
+    Messages carry the canonical JSON body, the properties `operation`,
+    `record_id`, `content_hash` and `source_url`, and a partition key of
+    `operation:record_id:content_hash`. No event timestamp is set. Delivery
+    is at-least-once; a failed block raises PublishError and is not retried.
+    """
+    topic = _topic(destination, producer)
+    _bounds(batch_size, max_message_bytes)
+    blocks = _blocks(_rows(batch), batch_size, max_message_bytes)
+    count, messages = 0, 0
+    for block in blocks:
+        try:
+            for key, body, properties in block:
+                producer.send(body, properties=properties, partition_key=key, event_timestamp=None)
+        except Exception:
+            raise PublishError(
+                f"Pulsar send block {count + 1} failed; earlier blocks may be delivered. "
+                "Inspect the destination and deduplicate by partition key on retry."
+            ) from None
+        count += 1
+        messages += len(block)
+    return PublishResult(topic, messages, count)
+
+
+def publish_operation(operation: str, args: dict[str, Any] | None, producer: Any, destination: str,
+                      *, api_key_env: str | None = None, complete_history: bool = True,
+                      max_pages: int = 10000, client_factory: Any = None,
+                      batch_size: int = 1000, max_message_bytes: int = MAX_MESSAGE_BYTES) -> PublishResult:
+    """Read one public operation and publish its complete response envelope."""
+    _topic(destination, producer)
+    _bounds(batch_size, max_message_bytes)
+    batch = read(operation, args, api_key_env=api_key_env,
+                 complete_history=complete_history, max_pages=max_pages,
+                 client_factory=client_factory)
+    return publish(batch, producer, destination, batch_size=batch_size,
+                   max_message_bytes=max_message_bytes)
+
+
+__all__ = ["COLUMNS", "MAX_MESSAGE_BYTES", "PROPERTIES", "PublishError", "PublishResult",
+           "encode_message", "message_key", "publish", "publish_operation"]

pulsar_fxmacrodata-0.1.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: pulsar-fxmacrodata
+Version: 0.1.0
+Summary: Publish public FXMacroData responses to Apache Pulsar
+License-Expression: MIT
+Project-URL: Documentation, https://fxmacrodata.com/documentation/reference?utm_source=pypi&utm_medium=referral&utm_campaign=pulsar-fxmacrodata&utm_content=package
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fxmacrodata-platform-core==0.1.0
+Requires-Dist: pulsar-client<4,>=3.13.0
+Provides-Extra: test
+Requires-Dist: pytest<9,>=8; extra == "test"
+Dynamic: license-file
+
+# FXMacroData for Apache Pulsar
+
+Publish FXMacroData public responses to a Pulsar topic with the official
+`pulsar-client` Python library. Stream macro announcements to your own
+subscriptions while retaining the source payload and revision metadata.
+
+[FXMacroData documentation](https://fxmacrodata.com/documentation/reference?utm_source=github&utm_medium=referral&utm_campaign=pulsar-fxmacrodata&utm_content=readme)
+
+## Install and connect
+
+Requires Python 3.10 or later. Install this package and its adjacent public
+client dependencies from the distribution supplied to you:
+
+```sh
+python -m pip install /path/to/fxmacrodata-public-client /path/to/fxmacrodata-platform-core /path/to/pulsar-fxmacrodata
+```
+
+Configure `PULSAR_SERVICE_URL` and any token file in your runtime secret
+store. Then publish through a producer bound to a customer-owned topic:
+
+```python
+import os
+import pulsar
+from fxmacrodata_platform_core import read
+from fxmacrodata_pulsar import publish
+
+TOPIC = "persistent://public/default/fxmacrodata"
+client = pulsar.Client(os.environ["PULSAR_SERVICE_URL"])
+try:
+    producer = client.create_producer(TOPIC)
+    batch = read("indicator_history", {"currency": "usd", "indicator": "policy_rate"})
+    result = publish(batch, producer, TOPIC)
+    print(result.messages, "messages in", result.batches, "blocks")
+finally:
+    client.close()
+```
+
+The destination is the topic name, either the full
+`persistent://tenant/namespace/topic` form or the short name, and it must
+match the topic the producer was created for. Service URLs and other values
+are rejected before any send.
+
+Every operation exposed by `fxmacrodata_platform_core.operations()` is
+available, including REST and MCP operations. `publish_operation` reads one
+operation and publishes it in a single call:
+
+```python
+from fxmacrodata_pulsar import publish_operation
+
+publish_operation("release_calendar", {"currency": "usd"}, producer, TOPIC,
+                  api_key_env="FXMD_API_KEY")
+```
+
+## Message format
+
+Each envelope row becomes one message. The body is canonical UTF-8 JSON with
+the keys `operation`, `source_url`, `record_id`, `currency`, `indicator`,
+`date`, `announcement_datetime`, `value`, `value_text`, `record_json`,
+`response_json` and the publisher's `content_hash` (SHA-256 of the ten source
+columns). Only `value` is numeric. Dates and announcement times remain source
+strings. No publication time is inferred, no missing value is filled, and no
+event timestamp is set on the message. `record_json` retains the original
+record; `response_json` retains the complete response, including pagination
+and metadata. An empty response produces one message with `record_json`
+equal to `"null"`, so absence of data and the server's metadata remain
+inspectable. It is not an observation.
+
+The partition key is `operation:record_id:content_hash`; the same source
+record with the same content always produces the same key, and changed data
+or metadata produces a different one. The properties `operation`,
+`record_id`, `content_hash` and `source_url` are set on every message for
+consumer-side filtering.
+
+## Delivery guarantee
+
+Delivery is at-least-once. Messages are sent in blocks of `batch_size` rows
+(1 to 10,000, 1,000 by default) with `Producer.send`, which blocks until the
+broker acknowledges each message; the producer's own batching settings
+decide how messages are grouped on the wire. A failed block raises
+`PublishError` without the broker's own diagnostic text and is not retried;
+earlier blocks may already be delivered. Consumers should deduplicate on the
+partition key, or on the `operation`, `record_id` and `content_hash`
+properties.
+
+`max_message_bytes` (16 MiB by default) rejects an individual envelope larger
+than the budget before anything is published; keep it within the broker's
+`maxMessageSize`, and narrow the source date range to reduce the response
+size. The source response is materialized before publishing; choose a source
+date range suitable for memory.
+
+`publish_operation` accepts `api_key_env`, `complete_history`, `max_pages`
+and `client_factory` for the public source reader. Supply source credentials
+through your runtime secret store, exposing only the environment variable
+name; omit `api_key_env` for anonymous USD access. Destination authentication
+belongs to the Pulsar client you create the producer from. The adapter
+neither saves nor prints credentials and never places one in a message or
+property.
+
+The package licence covers this adapter code. FXMacroData data access and
+onward redistribution remain subject to your subscription and applicable
+licence. Publishing data to a topic does not grant permission to publish or
+resell it.
+
+## Development
+
+Tests run offline against an in-memory fake producer:
+
+```sh
+python -m pytest tests -q
+```
+
+Official SDK reference:
+[pulsar-client Producer.send](https://pulsar.apache.org/api/python/3.13.x/pulsar.Producer.html?utm_source=pypi&utm_medium=referral&utm_campaign=pulsar-fxmacrodata&utm_content=upstream-reference#send).

pulsar_fxmacrodata-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+fxmacrodata_pulsar/__init__.py,sha256=9Nh8wUVcnON0A9ZWf_jSvVz_rlf5-WG9X64eCx_VUUs,6686
+fxmacrodata_pulsar/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pulsar_fxmacrodata-0.1.0.dist-info/licenses/LICENSE,sha256=rklK7Fl8aL1eWGubsrozZ7rCNTsN-MATw4M6LQIMv10,1092
+pulsar_fxmacrodata-0.1.0.dist-info/METADATA,sha256=4uM5fwh6F8kHY58Mh4Ds2I2pniHa2x_3BP_JKc2pPzM,5712
+pulsar_fxmacrodata-0.1.0.dist-info/WHEEL,sha256=16fc_9Rp854SLcdhaDEjr0u65p0e3FhZxihNgcnCE98,91
+pulsar_fxmacrodata-0.1.0.dist-info/top_level.txt,sha256=i9hDu12UclDlto5Yu_V72se4TJJ3vyjsxODIuYXcHSA,19
+pulsar_fxmacrodata-0.1.0.dist-info/RECORD,,

pulsar_fxmacrodata-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pulsar_fxmacrodata-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Tidball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pulsar_fxmacrodata-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fxmacrodata_pulsar