dagster-datacontract 0.1.0__tar.gz → 0.2.1__tar.gz

dagster_datacontract-0.2.1/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 2025 DataHeim
+
+   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.

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: dagster-datacontract
-Version: 0.1.0
+Version: 0.2.1
 Summary: Load metadata and asset check spesifications from data contracts.
 Author-email: Fredrik Bakken <fredrik@dataheim.io>
 Requires-Python: >=3.11.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: dagster>=1.10.9
 Requires-Dist: dagster-webserver>=1.10.9
 Requires-Dist: datacontract-cli>=0.10.23
+Dynamic: license-file
 
 # dagster-datacontract
 
@@ -50,7 +52,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/README.md

@@ -39,7 +39,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/dagster_datacontract/__init__.py

@@ -23,7 +23,6 @@ class DataContractLoader:
         )
         self.metadata = self._load_metadata()
         self.tags = self._load_tags()
-        self.description = self._load_description()
         self.owner = self._load_owner()
         self.version = self._load_version()
         self.cron_schedule = self._load_cron_schedule()
@@ -76,23 +75,6 @@ class DataContractLoader:
 
         return tags
 
-    def _load_description(self) -> str | None:
-        model_description = self.data_contract_specification.models.get(
-            self.asset_name
-        ).description.replace("\n", "\n\n")
-        info_description = self.data_contract_specification.info.description.replace(
-            "\n", "\n\n"
-        )
-
-        if model_description and info_description:
-            return f"{model_description}\n\n{info_description}"
-        elif model_description:
-            return textwrap.dedent(model_description)
-        elif info_description:
-            return textwrap.dedent(info_description)
-
-        return None
-
     def _load_owner(self) -> list[str] | None:
         owner = self.data_contract_specification.info.owner
 
@@ -112,7 +94,69 @@ class DataContractLoader:
         except AttributeError:
             return None
 
+    def load_description(
+        self, config: dict[str, Any] | None = None, separator: str = "\n"
+    ) -> str | None:
+        """Load and return a formatted description string based on the data contract specification.
+
+        This method composes a description by pulling text from different parts
+        of the data contract specification (e.g., model and info descriptions),
+        joining them using the specified separator.
+
+        Args:
+            config (dict[str, Any] | None, optional): A configuration dictionary
+                specifying the order in which to concatenate the description parts.
+                Defaults to `{"order": ["model", "info"]}`.
+            separator (str, optional): A string used to separate different parts
+                of the description. Defaults to a newline character (`"\n"`).
+
+        Returns:
+            str | None: A single string combining the specified description parts
+            if available, otherwise `None`.
+
+
+        Example:
+            >>> self.load_description()
+            'Model description...\nInfo description...'
+        """
+        default_config = {"order": ["model", "info"]}
+
+        configuration = default_config | (config or {})
+
+        descriptions = {
+            "model": self.data_contract_specification.models.get(
+                self.asset_name
+            ).description,
+            "info": self.data_contract_specification.info.description,
+        }
+
+        parts = []
+        for key in configuration["order"]:
+            desc = descriptions.get(key).replace("\n", f"{separator}\n")
+            if desc:
+                parts.append(textwrap.dedent(desc))
+
+        if parts:
+            return f"{separator}\n".join(parts)
+
+        return None
+
     def load_data_quality_checks(self) -> dg.AssetChecksDefinition:
+        """Define and return a data quality check for the specified asset.
+
+        This method registers a data quality check using the `@dg.asset_check`
+        decorator. The check runs the data contract's `test()` method and returns
+        the result as a `dg.AssetCheckResult`. The result is considered "passed"
+        if the test outcome matches `ResultEnum.passed`.
+
+        The check is marked as blocking, which means failures may halt downstream
+        processing in a data pipeline.
+
+        Returns:
+            dg.AssetChecksDefinition: The defined asset quality check function,
+            registered with Dagster's data quality framework.
+        """
+
         @dg.asset_check(
             asset=self.asset_key,
             blocking=True,
@@ -130,6 +174,27 @@ class DataContractLoader:
         return check_asset
 
     def load_freshness_checks(self, lower_bound_delta: timedelta):
+        """Generate and return freshness checks for the asset based on update recency.
+
+        This method builds freshness checks using Dagster's
+        `build_last_update_freshness_checks` utility. It ensures that the specified
+        asset has been updated within a given time window (`lower_bound_delta`).
+        A cron schedule (`self.cron_schedule`) defines when the check should run.
+
+        Args:
+            lower_bound_delta (timedelta): The minimum acceptable time difference
+                between the current time and the asset's last update timestamp.
+                If the asset is older than this delta, the check will fail.
+
+        Returns:
+            list[AssetCheckSpec] | AssetChecksDefinition: A freshness check definition
+            that can be returned from `define_asset_checks` to register the check.
+
+
+        Example:
+            >>> self.load_freshness_checks(timedelta(hours=24))
+            # Ensures the asset was updated in the last 24 hours.
+        """
         freshness_checks = dg.build_last_update_freshness_checks(
             assets=[self.asset_name],
             lower_bound_delta=lower_bound_delta,

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/dagster_datacontract.egg-info/PKG-INFO

@@ -1,13 +1,15 @@
 Metadata-Version: 2.4
 Name: dagster-datacontract
-Version: 0.1.0
+Version: 0.2.1
 Summary: Load metadata and asset check spesifications from data contracts.
 Author-email: Fredrik Bakken <fredrik@dataheim.io>
 Requires-Python: >=3.11.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: dagster>=1.10.9
 Requires-Dist: dagster-webserver>=1.10.9
 Requires-Dist: datacontract-cli>=0.10.23
+Dynamic: license-file
 
 # dagster-datacontract
 
@@ -50,7 +52,7 @@ data_contract = DataContractLoader(
     name=asset_name,
     metadata=data_contract.metadata,
     tags=data_contract.tags,
-    description=data_contract.description,
+    description=data_contract.load_description(),
     owners=data_contract.owner,
     code_version=data_contract.version,
 )

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/dagster_datacontract.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 dagster_datacontract/__init__.py

{dagster_datacontract-0.1.0 → dagster_datacontract-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dagster-datacontract"
-version = "0.1.0"
+version = "0.2.1"
 description = "Load metadata and asset check spesifications from data contracts."
 authors = [
     { name = "Fredrik Bakken", email = "fredrik@dataheim.io" }