digitalhub 0.11.0b7__py3-none-any.whl → 0.13.0__py3-none-any.whl

digitalhub/utils/io_utils.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from pathlib import Path
@@ -11,14 +15,14 @@ import yaml
 
 def write_yaml(filepath: str | Path, obj: dict | list[dict]) -> None:
     """
-    Write a dict or a list of dict to a yaml file.
+    Write a dict or a list of dicts to a YAML file.
 
     Parameters
     ----------
-    filepath : str | Path
-        The yaml file path to write.
-    obj : dict
-        The dict to write.
+    filepath : str or Path
+        The YAML file path to write.
+    obj : dict or list of dict
+        The dict or list of dicts to write.
 
     Returns
     -------
@@ -57,7 +61,7 @@ def write_text(filepath: Path, text: str) -> None:
 
 class NoDatesSafeLoader(yaml.SafeLoader):
     """
-    Loader implementation to exclude implicit resolvers.
+    Loader implementation to exclude implicit resolvers for YAML timestamps.
 
     Taken from https://stackoverflow.com/a/37958106
     """
@@ -65,16 +69,17 @@ class NoDatesSafeLoader(yaml.SafeLoader):
     @classmethod
     def remove_implicit_resolver(cls, tag_to_remove: str) -> None:
         """
-        Remove implicit resolvers for a particular tag
+        Remove implicit resolvers for a particular tag.
+
         Takes care not to modify resolvers in super classes.
         We want to load datetimes as strings, not dates, because we
-        go on to serialise as json which doesn't have the advanced types
-        of yaml, and leads to incompatibilities down the track.
+        go on to serialize as JSON which doesn't have the advanced types
+        of YAML, and leads to incompatibilities down the track.
 
         Parameters
         ----------
         tag_to_remove : str
-            The tag to remove
+            The tag to remove.
 
         Returns
         -------
@@ -94,17 +99,17 @@ NoDatesSafeLoader.remove_implicit_resolver("tag:yaml.org,2002:timestamp")
 
 def read_yaml(filepath: str | Path) -> dict | list[dict]:
     """
-    Read a yaml file and return a dict or a list of dict.
+    Read a YAML file and return its content as a dict or a list of dicts.
 
     Parameters
     ----------
-    filepath : str | Path
-        The yaml file path to read.
+    filepath : str or Path
+        The YAML file path to read.
 
     Returns
     -------
-    dict | list[dict]
-        The yaml file content.
+    dict or list of dict
+        The YAML file content.
     """
     try:
         with open(filepath, "r", encoding="utf-8") as in_file:
@@ -119,16 +124,16 @@ def read_yaml(filepath: str | Path) -> dict | list[dict]:
 
 def read_text(filepath: str | Path) -> str:
     """
-    Read a file and return the text.
+    Read a file and return its text content.
 
     Parameters
     ----------
-    filepath : str | Path
+    filepath : str or Path
         The file path to read.
 
     Returns
     -------
     str
-        The file content.
+        The file content as a string.
     """
     return Path(filepath).read_text(encoding="utf-8")

digitalhub/utils/logger.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import logging

digitalhub/utils/types.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 from typing import Union

digitalhub/utils/uri_utils.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import re
@@ -9,7 +13,7 @@ from digitalhub.utils.generic_utils import list_enum
 
 class S3Schemes(Enum):
     """
-    S3 schemes.
+    S3 URI schemes.
     """
 
     S3 = "s3"
@@ -20,7 +24,7 @@ class S3Schemes(Enum):
 
 class LocalSchemes(Enum):
     """
-    Local schemes.
+    Local URI schemes.
     """
 
     LOCAL = ""
@@ -28,7 +32,7 @@ class LocalSchemes(Enum):
 
 class InvalidLocalSchemes(Enum):
     """
-    Local schemes.
+    Invalid local URI schemes.
     """
 
     FILE = "file"
@@ -37,7 +41,7 @@ class InvalidLocalSchemes(Enum):
 
 class RemoteSchemes(Enum):
     """
-    Remote schemes.
+    Remote URI schemes.
     """
 
     HTTP = "http"
@@ -48,7 +52,7 @@ class RemoteSchemes(Enum):
 
 class SqlSchemes(Enum):
     """
-    Sql schemes.
+    SQL URI schemes.
     """
 
     SQL = "sql"
@@ -57,7 +61,7 @@ class SqlSchemes(Enum):
 
 class GitSchemes(Enum):
     """
-    Git schemes.
+    Git URI schemes.
     """
 
     GIT = "git"
@@ -67,7 +71,7 @@ class GitSchemes(Enum):
 
 class SchemeCategory(Enum):
     """
-    Scheme types.
+    URI scheme categories.
     """
 
     S3 = "s3"
@@ -79,17 +83,17 @@ class SchemeCategory(Enum):
 
 def map_uri_scheme(uri: str) -> str:
     """
-    Map an URI scheme to a common scheme.
+    Map a URI scheme to a common scheme category.
 
     Parameters
     ----------
     uri : str
-        URI.
+        URI string.
 
     Returns
     -------
     str
-        Mapped scheme type.
+        Mapped scheme category (e.g., 'local', 'remote', 's3', 'sql', 'git').
 
     Raises
     ------
@@ -118,118 +122,118 @@ def map_uri_scheme(uri: str) -> str:
 
 def has_local_scheme(uri: str) -> bool:
     """
-    Check if uri is local.
+    Check if a URI has a local scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is local.
+        True if the URI is local, False otherwise.
     """
     return map_uri_scheme(uri) == SchemeCategory.LOCAL.value
 
 
 def has_remote_scheme(uri: str) -> bool:
     """
-    Check if uri is remote.
+    Check if a URI has a remote scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is remote.
+        True if the URI is remote, False otherwise.
     """
     return map_uri_scheme(uri) == SchemeCategory.REMOTE.value
 
 
 def has_s3_scheme(uri: str) -> bool:
     """
-    Check if uri is s3.
+    Check if a URI has an S3 scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is s3.
+        True if the URI is S3, False otherwise.
     """
     return map_uri_scheme(uri) == SchemeCategory.S3.value
 
 
 def has_sql_scheme(uri: str) -> bool:
     """
-    Check if uri is sql.
+    Check if a URI has an SQL scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is sql.
+        True if the URI is SQL, False otherwise.
     """
     return map_uri_scheme(uri) == SchemeCategory.SQL.value
 
 
 def has_git_scheme(uri: str) -> bool:
     """
-    Check if uri is git.
+    Check if a URI has a git scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is git.
+        True if the URI is git, False otherwise.
     """
     return map_uri_scheme(uri) == SchemeCategory.GIT.value
 
 
 def has_zip_scheme(uri: str) -> bool:
     """
-    Check if uri is zip.
+    Check if a URI has a zip scheme.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     bool
-        True if uri is zip.
+        True if the URI is zip, False otherwise.
     """
     return uri.startswith("zip+")
 
 
 def get_filename_from_uri(uri: str) -> str:
     """
-    Get filename from uri.
+    Get the filename from a URI.
 
     Parameters
     ----------
     uri : str
-        Uri of some source.
+        URI string.
 
     Returns
     -------
     str
-        Filename.
+        Filename extracted from the URI.
     """
     return unquote(urlparse(uri).path).split("/")[-1]

digitalhub-0.13.0.dist-info/METADATA

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: digitalhub
+Version: 0.13.0
+Summary: Python SDK for Digitalhub
+Project-URL: Homepage, https://github.com/scc-digitalhub/digitalhub-sdk
+Author-email: Fondazione Bruno Kessler <digitalhub@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
+License:                                  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 DSLab, Fondazione Bruno Kessler
+        
+           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.
+License-File: AUTHORS
+License-File: LICENSE
+Keywords: data,dataops,kubernetes
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <3.13,>=3.9
+Requires-Dist: boto3
+Requires-Dist: gitpython>=3
+Requires-Dist: numpy
+Requires-Dist: psycopg2-binary
+Requires-Dist: pyarrow
+Requires-Dist: pydantic
+Requires-Dist: python-slugify
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: sqlalchemy
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == 'dev'
+Requires-Dist: jsonschema; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Provides-Extra: full
+Requires-Dist: mlflow; extra == 'full'
+Requires-Dist: pandas; extra == 'full'
+Provides-Extra: mlflow
+Requires-Dist: mlflow; extra == 'mlflow'
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# DigitalHub SDK
+
+[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/scc-digitalhub/digitalhub-sdk/LICENSE) ![GitHub Release](https://img.shields.io/github/v/release/scc-digitalhub/digitalhub-sdk)
+![Status](https://img.shields.io/badge/status-stable-gold)
+
+The Digitalhub library is a python tool for managing projects, entities and executions in Digitalhub. It exposes CRUD methods to create, read, update and delete entities, tools to execute functions or workflows, collect or store execution results and data.
+
+Explore the full documentation at the [link](https://scc-digitalhub.github.io/sdk-docs/).
+
+## Quick start
+
+To install the Digitalhub, you can use pip:
+
+```bash
+pip install digitalhub
+```
+
+To be able to create and execute functions or workflows, you need to install the runtime you want to use. The Digitalhub SDK supports multiple runtimes, each with its own installation instructions:
+
+- [Digitalhub SDK Runtime Python](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-python)
+- [Digitalhub SDK Runtime Dbt](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-dbt)
+- [Digitalhub SDK Runtime Container](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-container)
+- [Digitalhub SDK Runtime Kfp](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-kfp)
+- [Digitalhub SDK Runtime Modelserve](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-modelserve)
+
+## Development
+
+See CONTRIBUTING for contribution instructions.
+
+## Security Policy
+
+The current release is the supported version. Security fixes are released together with all other fixes in each new release.
+
+If you discover a security vulnerability in this project, please do not open a public issue.
+
+Instead, report it privately by emailing us at digitalhub@fbk.eu. Include as much detail as possible to help us understand and address the issue quickly and responsibly.
+
+## Contributing
+
+To report a bug or request a feature, please first check the existing issues to avoid duplicates. If none exist, open a new issue with a clear title and a detailed description, including any steps to reproduce if it's a bug.
+
+To contribute code, start by forking the repository. Clone your fork locally and create a new branch for your changes. Make sure your commits follow the [Conventional Commits v1.0](https://www.conventionalcommits.org/en/v1.0.0/) specification to keep history readable and consistent.
+
+Once your changes are ready, push your branch to your fork and open a pull request against the main branch. Be sure to include a summary of what you changed and why. If your pull request addresses an issue, mention it in the description (e.g., “Closes #123”).
+
+Please note that new contributors may be asked to sign a Contributor License Agreement (CLA) before their pull requests can be merged. This helps us ensure compliance with open source licensing standards.
+
+We appreciate contributions and help in improving the project!
+
+## Authors
+
+This project is developed and maintained by **DSLab – Fondazione Bruno Kessler**, with contributions from the open source community. A complete list of contributors is available in the project’s commit history and pull requests.
+
+For questions or inquiries, please contact: [digitalhub@fbk.eu](mailto:digitalhub@fbk.eu)
+
+## Copyright and license
+
+Copyright © 2025 DSLab – Fondazione Bruno Kessler and individual contributors.
+
+This project is licensed under the Apache License, Version 2.0.
+You may not use this file except in compliance with the License. Ownership of contributions remains with the original authors and is governed by the terms of the Apache 2.0 License, including the requirement to grant a license to the project.