masterly 0.1.1__py3-none-any.whl

masterly/__init__.py

@@ -0,0 +1,14 @@
+"""Masterly Python client — extract governed data products, ingest records.
+
+A thin, typed wrapper over the stable ``/v1`` REST contract (the same API the GUI, MCP,
+and stream channels ride). Built for notebook and pipeline use on Databricks, Microsoft
+Fabric, and plain Python: sync calls, cursor paging handled for you, optional pandas.
+"""
+
+from masterly._client import ApiError, Client
+from masterly._extract import ChangeFeed, RowPages
+from masterly._ingest import IngestReport
+
+__version__ = "0.1.1"
+
+__all__ = ["ApiError", "ChangeFeed", "Client", "IngestReport", "RowPages", "__version__"]

masterly/_client.py

@@ -0,0 +1,89 @@
+"""The client shell: connection, auth, error mapping. Every call carries the bearer token
+and the Environment header; errors surface the server's error envelope verbatim."""
+
+from __future__ import annotations
+
+import contextlib
+from typing import Any
+
+import httpx
+
+from masterly._extract import GoldenApi, ProductsApi
+from masterly._ingest import SourcesApi
+
+_TIMEOUT = httpx.Timeout(30.0, connect=10.0)
+
+
+class ApiError(Exception):
+    """A non-2xx answer from the API, carrying the server's error code and message."""
+
+    def __init__(self, status_code: int, code: str, message: str) -> None:
+        self.status_code = status_code
+        self.code = code
+        self.message = message
+        super().__init__(f"{code} ({status_code}): {message}")
+
+
+class Client:
+    """Connection to one Masterly Environment.
+
+    Args:
+        base_url: The install's URL, e.g. ``https://app.example.com``.
+        token: A session or service-account bearer token.
+        environment: The Environment id, e.g. ``env_prod_eu``.
+    """
+
+    def __init__(
+        self,
+        base_url: str,
+        token: str,
+        environment: str,
+        *,
+        transport: httpx.BaseTransport | None = None,
+    ) -> None:
+        from masterly import __version__
+
+        self._http = httpx.Client(
+            base_url=base_url.rstrip("/"),
+            headers={
+                "Authorization": f"Bearer {token}",
+                "X-Masterly-Environment": environment,
+                "User-Agent": f"masterly-python/{__version__}",
+            },
+            timeout=_TIMEOUT,
+            transport=transport,
+        )
+        self.products = ProductsApi(self)
+        self.sources = SourcesApi(self)
+        self.golden = GoldenApi(self)
+
+    def close(self) -> None:
+        self._http.close()
+
+    def __enter__(self) -> Client:
+        return self
+
+    def __exit__(self, *exc: object) -> None:
+        self.close()
+
+    # --- internal ---------------------------------------------------------------------
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        params: dict[str, Any] | None = None,
+        json: Any | None = None,
+    ) -> Any:
+        response = self._http.request(method, path, params=params, json=json)
+        if response.status_code >= 400:
+            code, message = "HTTP_ERROR", response.text[:500]
+            with contextlib.suppress(Exception):  # a non-JSON error body stays a plain HTTP error
+                envelope = response.json().get("error", {})
+                code = envelope.get("code", code)
+                message = envelope.get("message", message)
+            raise ApiError(response.status_code, code, message)
+        if response.status_code == 204 or not response.content:
+            return None
+        return response.json()

masterly/_extract.py

@@ -0,0 +1,122 @@
+"""Extract: data products (paged reads + the resumable change feed) and golden records.
+
+Iterators own the cursor plumbing — a notebook writes ``for row in client.products.read(...)``
+and never sees a page. ``to_pandas()`` is available wherever pandas is installed
+(``pip install masterly[pandas]``); it is never imported unless asked for.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:  # pandas stays optional at runtime
+    import pandas
+
+    from masterly._client import Client
+
+_PAGE_SIZE = 200  # the API caps limit at 200
+
+
+def _to_pandas(rows: Iterator[dict[str, Any]]) -> pandas.DataFrame:
+    try:
+        import pandas
+    except ImportError as exc:  # pragma: no cover - environment-specific
+        raise ImportError(
+            "pandas is not installed — install the extra: pip install masterly[pandas]"
+        ) from exc
+    return pandas.DataFrame(list(rows))
+
+
+class RowPages:
+    """Iterates every row of a product (or golden listing), fetching pages lazily."""
+
+    def __init__(
+        self, client: Client, path: str, params: dict[str, Any] | None = None
+    ) -> None:
+        self._client = client
+        self._path = path
+        self._params = params or {}
+
+    def __iter__(self) -> Iterator[dict[str, Any]]:
+        cursor: str | None = None
+        while True:
+            params: dict[str, Any] = {**self._params, "limit": _PAGE_SIZE}
+            if cursor:
+                params["cursor"] = cursor
+            page = self._client._request("GET", self._path, params=params)
+            yield from page.get("items", [])
+            cursor = page.get("next_cursor")
+            if not cursor:
+                return
+
+    def to_pandas(self) -> pandas.DataFrame:
+        """All rows as a DataFrame. Loads everything — page manually for huge products."""
+        return _to_pandas(iter(self))
+
+
+class ChangeFeed:
+    """The product change feed with a **resumable cursor** (persist ``feed.cursor`` after a
+    run and pass it back next time — every change is delivered at least once)."""
+
+    def __init__(self, client: Client, path: str, cursor: str | None) -> None:
+        self._client = client
+        self._path = path
+        self.cursor = cursor
+
+    def __iter__(self) -> Iterator[dict[str, Any]]:
+        while True:
+            params: dict[str, Any] = {"limit": _PAGE_SIZE}
+            if self.cursor:
+                params["cursor"] = self.cursor
+            page = self._client._request("GET", self._path, params=params)
+            items = page.get("items", [])
+            yield from items
+            next_cursor = page.get("next_cursor")
+            if next_cursor:
+                self.cursor = next_cursor
+            if not next_cursor or not items:
+                return
+
+
+class ProductsApi:
+    def __init__(self, client: Client) -> None:
+        self._client = client
+
+    def list(self) -> list[dict[str, Any]]:
+        """Every data product visible to the caller."""
+        page = self._client._request("GET", "/v1/data-products")
+        items: list[dict[str, Any]] = page.get("items", [])
+        return items
+
+    def _resolve(self, product: str) -> str:
+        """Accept a product id (``dp_…``) or its exact name."""
+        if product.startswith("dp_"):
+            return product
+        matches = [p for p in self.list() if p.get("name") == product]
+        if not matches:
+            raise LookupError(f"no data product named '{product}'")
+        product_id: str = matches[0]["product_id"]
+        return product_id
+
+    def read(self, product: str, **params: Any) -> RowPages:
+        """Every row of a published product, cursor-paged behind the iterator."""
+        product_id = self._resolve(product)
+        return RowPages(self._client, f"/v1/consume/products/{product_id}", params)
+
+    def changes(self, product: str, cursor: str | None = None) -> ChangeFeed:
+        """Changes since ``cursor`` (or from the beginning). Persist ``feed.cursor``."""
+        product_id = self._resolve(product)
+        return ChangeFeed(self._client, f"/v1/consume/products/{product_id}/changes", cursor)
+
+
+class GoldenApi:
+    def __init__(self, client: Client) -> None:
+        self._client = client
+
+    def list(self, model: str, *, q: str | None = None) -> RowPages:
+        """Golden records of a model — the resolved single view, before any product shaping."""
+        params: dict[str, Any] = {"model": model}
+        if q:
+            params["q"] = q
+        return RowPages(self._client, "/v1/golden", params)

masterly/_ingest.py

@@ -0,0 +1,68 @@
+"""Ingest: deliver records to a source. Batches are chunked client-side and accepted
+asynchronously by the platform (202) — mapping, validation, quarantine, matching, and
+golden resolution run exactly as for every other channel."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from masterly._client import Client
+
+_BATCH_SIZE = 500
+
+
+@dataclass(frozen=True)
+class IngestReport:
+    """What was handed to the platform. Acceptance is asynchronous: invalid records land in
+    the source's quarantine with a reason rather than failing the call."""
+
+    source_id: str
+    records: int
+    batches: int
+
+
+class SourcesApi:
+    def __init__(self, client: Client) -> None:
+        self._client = client
+
+    def list(self) -> list[dict[str, Any]]:
+        page = self._client._request("GET", "/v1/sources")
+        items: list[dict[str, Any]] = page.get("items", [])
+        return items
+
+    def _resolve(self, source: str) -> str:
+        """Accept a source id (``src_…``) or its exact name."""
+        if source.startswith("src_"):
+            return source
+        matches = [s for s in self.list() if s.get("name") == source]
+        if not matches:
+            raise LookupError(f"no source named '{source}'")
+        source_id: str = matches[0]["source_id"]
+        return source_id
+
+    def ingest(
+        self,
+        source: str,
+        records: Sequence[dict[str, Any]],
+        *,
+        batch_size: int = _BATCH_SIZE,
+    ) -> IngestReport:
+        """Deliver records to a source, chunked into accepted batches.
+
+        Re-delivery is safe: records upsert by their source key, so running the same
+        notebook twice never duplicates data.
+        """
+        if batch_size < 1:
+            raise ValueError("batch_size must be at least 1")
+        source_id = self._resolve(source)
+        batches = 0
+        for start in range(0, len(records), batch_size):
+            chunk = records[start : start + batch_size]
+            self._client._request(
+                "POST", "/v1/ingest", json={"source_id": source_id, "records": chunk}
+            )
+            batches += 1
+        return IngestReport(source_id=source_id, records=len(records), batches=batches)

masterly-0.1.1.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: masterly
+Version: 0.1.1
+Summary: Python client for Masterly — extract governed data products and ingest records from your lakehouse
+Project-URL: Homepage, https://masterlydata.com
+Project-URL: Documentation, https://masterlydata.com/docs/reference/python-sdk/
+Project-URL: Repository, https://github.com/masterly-data/masterly-python-sdk
+Project-URL: Changelog, https://github.com/masterly-data/masterly-python-sdk/releases
+License: Apache-2.0
+License-File: LICENSE
+Keywords: data products,databricks,fabric,lakehouse,master data,mdm,snowflake
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# masterly — Python client
+
+Extract governed data products and ingest records from Python — notebooks on Databricks,
+Microsoft Fabric, or anywhere else your pipelines run.
+
+```python
+from masterly import Client
+
+client = Client(
+    base_url="https://app.example.com",       # your Masterly install
+    token="<session or service-account token>",
+    environment="env_prod_eu",
+)
+
+# Extract: page through a data product (cursor-managed for you)
+for row in client.products.read("Customer 360"):
+    ...
+
+# Or straight into a DataFrame
+df = client.products.read("Customer 360").to_pandas()
+
+# Follow the change feed with a resumable cursor
+feed = client.products.changes("Customer 360", cursor=saved_cursor)
+for change in feed:
+    ...
+save(feed.cursor)  # persist for the next run
+
+# Ingest: deliver records to a source (chunked automatically)
+report = client.sources.ingest("crm", records)
+print(report.records, "records in", report.batches, "batches")
+```
+
+## Tokens: two personas
+
+- **Consumer** (extract in a Databricks/Fabric job): use a **service-account token**
+  (minted under Users → Service accounts). It pins its Environment and consumes published
+  products — reference them **by product id** (`dp_…`), since listing products needs a
+  session. Access policies (row rules, masks) apply per consumer automatically.
+- **Integrator** (ingest + golden reads): use a **session token**. Sources and products can
+  be referenced by name.
+
+The client is a thin, typed wrapper over the stable `/v1` REST contract — the same API
+every other channel uses. Errors raise `masterly.ApiError` carrying the server's error
+code and message. Re-delivery is idempotent: records upsert by their source key, so
+running the same notebook twice never duplicates data.
+
+`pandas` is an optional dependency: `pip install masterly[pandas]`.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

masterly-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+masterly/__init__.py,sha256=s5yIn2MzZCIKPoTCYHT9Q1GkA2te8F3TLMFui5U82ho,599
+masterly/_client.py,sha256=kOkxqdqGg3QMEtmhrXhKWdVFLet0M7yO2NA7zPjjmH0,2812
+masterly/_extract.py,sha256=jWo0ALsCBm_M18ERz6lobMGtrlb2VMc-1skqkbwM1v8,4577
+masterly/_ingest.py,sha256=FIhownjEdU1ZtvZycrF6uvqZMgeOrLPKSXPwFv2Nu0M,2307
+masterly/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+masterly-0.1.1.dist-info/METADATA,sha256=5ztU-aXUn30JM9H5Q7FiB5lCk4hzXikeKGTZaxOVFIw,3127
+masterly-0.1.1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+masterly-0.1.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+masterly-0.1.1.dist-info/RECORD,,

masterly-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

masterly-0.1.1.dist-info/licenses/LICENSE

@@ -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 [yyyy] [name of copyright owner]
+
+   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.