lakeflow-fxmacrodata 0.1.0__py3-none-any.whl

databricks/labs/community_connector/sources/fxmacrodata/__init__.py

@@ -0,0 +1,7 @@
+from databricks.labs.community_connector.sparkpds import LakeflowSource
+from .fxmacrodata import FXMacroDataLakeflowConnect
+
+class FXMacroDataDataSource(LakeflowSource):
+    _lakeflow_connect_cls = FXMacroDataLakeflowConnect
+
+__all__ = ["FXMacroDataLakeflowConnect", "FXMacroDataDataSource"]

databricks/labs/community_connector/sources/fxmacrodata/fxmacrodata.py

@@ -0,0 +1,66 @@
+"""Native Lakeflow snapshot ingestion of documented FXMacroData operations."""
+import json
+import re
+from databricks.labs.community_connector.interface.lakeflow_connect import LakeflowConnect
+from pyspark.sql.types import DoubleType, StringType, StructField, StructType
+from fxmacrodata_platform_core import COLUMNS, IntegrationError, read, schemas, validate_request
+
+_FRAMEWORK_OPTIONS = {"externalOptionsAllowList", "sourceName", "tableName", "tableNameList",
+                      "tableConfigs", "isDeleteFlow", "namespacePrefix", "namespace"}
+_SOURCE_OPTIONS = {"api_key_env", "arguments", "max_pages", "complete_history"}
+
+class FXMacroDataLakeflowConnect(LakeflowConnect):
+    def __init__(self, options: dict[str, str]):
+        if set(options) - (_FRAMEWORK_OPTIONS | _SOURCE_OPTIONS):
+            raise IntegrationError("Use only documented connection options and a runtime secret reference.")
+        env = options.get("api_key_env") or None
+        if env is not None and not re.fullmatch(r"[A-Z][A-Z0-9_]{0,127}", env):
+            raise IntegrationError("API-key option must name an environment variable.")
+        super().__init__(dict(options))
+        self.api_key_env = env
+
+    def list_tables(self) -> list[str]:
+        return ["operation_catalog", *sorted(schemas())]
+
+    def get_table_schema(self, table_name, table_options):
+        self._options(table_name, table_options)
+        if table_name == "operation_catalog":
+            return StructType([StructField("operation", StringType(), False),
+                               StructField("input_schema_json", StringType(), False)])
+        return StructType([StructField(name, DoubleType() if name == "value" else StringType(), True)
+                           for name in COLUMNS])
+
+    def read_table_metadata(self, table_name, table_options):
+        self._options(table_name, table_options)
+        return {"primary_keys": ["operation"] if table_name == "operation_catalog" else ["record_id"],
+                "cursor_field": None, "ingestion_type": "snapshot"}
+
+    def _options(self, table_name, table_options):
+        if table_name not in self.list_tables():
+            raise IntegrationError("Unknown table; use list_tables().")
+        if set(table_options) - (_FRAMEWORK_OPTIONS | _SOURCE_OPTIONS):
+            raise IntegrationError("Unsupported table option.")
+        try:
+            args = json.loads(table_options.get("arguments", "{}"))
+            pages = int(table_options.get("max_pages", "1000"))
+        except (TypeError, ValueError):
+            raise IntegrationError("Use a JSON arguments object and integer page budget.") from None
+        history = table_options.get("complete_history", "true")
+        if not 1 <= pages <= 10000 or history not in {"true", "false"}:
+            raise IntegrationError("Invalid history mode or page budget.")
+        if table_name != "operation_catalog":
+            args = validate_request(table_name, args)
+        elif args:
+            raise IntegrationError("Operation catalogue does not accept arguments.")
+        return args, pages, history == "true"
+
+    def read_table(self, table_name, start_offset, table_options):
+        args, pages, history = self._options(table_name, table_options)
+        if table_name == "operation_catalog":
+            rows = [{"operation": name, "input_schema_json": json.dumps(schema, sort_keys=True)}
+                    for name, schema in sorted(schemas().items())]
+        else:
+            rows = read(table_name, args, api_key_env=self.api_key_env,
+                        complete_history=history, max_pages=pages).rows()
+        # None is the framework contract for a complete snapshot without an incremental offset.
+        return iter(rows), None

lakeflow_fxmacrodata-0.1.0.data/data/share/lakeflow-fxmacrodata/connector_spec.yaml

@@ -0,0 +1,8 @@
+display_name: FXMacroData
+connection:
+  parameters:
+    - name: api_key_env
+      type: string
+      required: false
+      description: Environment-variable name containing the customer's API key on the ingestion runtime. Leave empty for anonymous USD access.
+external_options_allowlist: "arguments,max_pages,complete_history"

lakeflow_fxmacrodata-0.1.0.dist-info/METADATA

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: lakeflow-fxmacrodata
+Version: 0.1.0
+Summary: FXMacroData custom connector for Databricks Lakeflow Connect
+License: 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.
+        
+Project-URL: Homepage, https://fxmacrodata.com/?utm_source=pypi&utm_medium=referral&utm_campaign=lakeflow-fxmacrodata&utm_content=homepage
+Project-URL: Documentation, https://fxmacrodata.com/documentation/reference?utm_source=pypi&utm_medium=referral&utm_campaign=lakeflow-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: lakeflow-community-connectors<1,>=0.1.0
+Dynamic: license-file
+
+# FXMacroData for Databricks Lakeflow Connect
+
+Install this wheel as a workspace library alongside the Lakeflow Community Connectors framework. Its public client and platform core dependencies resolve from PyPI. Build the framework wheel from the official repository using Databricks' documented custom-connector procedure; do not assume it is available on PyPI. The framework interface used here is version 0.1.0 at [revision fc69fe7907f640e5283da40d4df0004db73c850b](https://github.com/databrickslabs/lakeflow-community-connectors/tree/fc69fe7907f640e5283da40d4df0004db73c850b). Install the framework wheel and adapter wheel together so the dependency resolver can find the source-built framework. PySpark is supplied by the Databricks runtime. This is a native `LakeflowConnect` implementation and `LakeflowSource` Spark data source.
+
+```python
+from databricks.labs.community_connector.sources.fxmacrodata import FXMacroDataDataSource
+spark.dataSource.register(FXMacroDataDataSource)
+```
+
+For the Add data custom connector tile, use source name `fxmacrodata`, display name `FXMacroData`, the supplied connector specification, and the framework/client/core/connector wheel libraries from a Unity Catalog volume. Follow [Databricks custom connector setup](https://docs.databricks.com/aws/en/ingestion/custom-connectors). A Unity Catalog workspace and compatible Lakeflow runtime are required.
+
+The source archive includes `connector_spec.yaml`. The wheel also installs it
+under `share/lakeflow-fxmacrodata` within the library environment, for use when
+configuring the custom connector tile. Install framework and adapter wheels in
+the same environment so their Databricks package directories are colocated.
+
+Discover the `operation_catalog` table to find all 33 REST operations and 54 MCP tools. Each operation is a table; configure its `arguments` option with a JSON object matching the catalogue schema. For example, table `release_calendar` accepts `{"currency":"usd"}`. Table `indicator_history` accepts `{"currency":"usd","indicator":"policy_rate","value_mode":"source"}`. Keep values and revisions in `record_json` and access, provenance, units and publication evidence in `response_json`.
+
+The connector uses full snapshot refreshes because historical data can revise. It declares snapshot ingestion and returns no incremental offset; it does not infer change-data-capture or deletion events. Offset and calendar cursor histories have explicit page budgets. Set `complete_history=false` to request one page or bounded feed call. An exhausted budget fails the read rather than returning an apparently complete snapshot.
+
+Leave `api_key_env` empty for anonymous access. To use paid access, arrange for the named variable to be available in the ingestion runtime through your workspace's secret-backed environment configuration. Put the variable name in the connection specification; never put the key in arguments, notebooks or connection options. Serverless environments that cannot supply this variable can use anonymous access; provision a compatible secret-backed runtime for protected data.
+
+Anonymous USD data has the API's published delay and history limits. Other datasets require the appropriate subscription. Loading data into your workspace does not grant redistribution rights. This package supplies the custom connector; it is not a Databricks-managed connector or Marketplace listing.

lakeflow_fxmacrodata-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+databricks/labs/community_connector/sources/fxmacrodata/__init__.py,sha256=6lsxnXhC74sD1kfKH8HFbQ7_AKxtmbJ5jLAk1hvbv2g,299
+databricks/labs/community_connector/sources/fxmacrodata/fxmacrodata.py,sha256=7WRLTC38oLe5IV69-5giqilC4fsEYRoU-Ru-vkFbRE0,3804
+lakeflow_fxmacrodata-0.1.0.data/data/share/lakeflow-fxmacrodata/connector_spec.yaml,sha256=slOYdzRX6dj1yQmZxWGEofQKMBLAfvh4UIz3omnhdVg,335
+lakeflow_fxmacrodata-0.1.0.dist-info/licenses/LICENSE,sha256=rklK7Fl8aL1eWGubsrozZ7rCNTsN-MATw4M6LQIMv10,1092
+lakeflow_fxmacrodata-0.1.0.dist-info/METADATA,sha256=W3Z3sgxKJe-XoM8ORcqaPB8qfMguyDwirPaYlSNcwbE,5363
+lakeflow_fxmacrodata-0.1.0.dist-info/WHEEL,sha256=16fc_9Rp854SLcdhaDEjr0u65p0e3FhZxihNgcnCE98,91
+lakeflow_fxmacrodata-0.1.0.dist-info/top_level.txt,sha256=7kRdatoSgU0EUurRQJ_3F1Nv4EOSHWAr6ng25tJOJKU,11
+lakeflow_fxmacrodata-0.1.0.dist-info/RECORD,,

lakeflow_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
+

lakeflow_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.

lakeflow_fxmacrodata-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+databricks