digitalhub 0.10.0b1__tar.gz → 0.10.0b3__tar.gz

digitalhub-0.10.0b3/.github/scripts/bump.sh

@@ -0,0 +1,40 @@
+# Extract version
+VERSION=$(bumpver show -n --environ | grep CUR | awk '{gsub(/CURRENT_VERSION=/, ""); print}')
+
+# Check if version include beta tag
+if [[ $VERSION == *"b"* ]];
+    then HAS_BETA_TAG=1;
+    else HAS_BETA_TAG=0;
+fi
+
+# Evaluate version bumping request
+case $1 in
+    new-beta-major|new-beta-minor|new-beta-patch)
+        rel=$(echo $1 | awk '{gsub(/new-beta-/, ""); print}')
+        if [ $HAS_BETA_TAG -eq 0 ];
+        then
+            bumpver update -n --$rel --tag=beta
+        else
+            echo "You can create a new beta from a final version! Current version: $VERSION"; exit 1;
+        fi
+        ;;
+    final)
+        if [ $HAS_BETA_TAG -eq 1 ];
+        then
+            bumpver update -n --tag=final
+        else
+            echo "You can create a final version from a beta version! Current version: $VERSION"; exit 1;
+        fi
+        ;;
+    upgrade-beta)
+        if [ $HAS_BETA_TAG -eq 1 ];
+        then
+            bumpver update -n --tag-num
+        else
+            echo "You can upgrade a beta from a beta version! Current version: $VERSION"; exit 1;
+        fi
+        ;;
+    major|minor|patch)
+        bumpver update -n --$1 --tag=final
+        ;;
+esac

digitalhub-0.10.0b3/.github/scripts/changelog.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+if [ "$2" = "true" ]; then
+  touch CHANGELOG.md
+else
+  git-cliff --unreleased --tag ${1}  -c .github/scripts/cliff.toml -v -o
+fi

digitalhub-0.10.0b3/.github/scripts/cliff.toml

@@ -0,0 +1,78 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+Changelog\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
+{% if previous %}\
+    {% if previous.commit_id and commit_id %}
+        [{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\
+            [{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
+    {% endif %}\
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | split(pat="\n") | first | upper_first | trim }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
+          {% for footer in commit.footers -%}
+            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
+          {% endfor %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 --> Features" },
+  { message = "^fix", group = "<!-- 1 --> Bug Fixes" },
+  { message = "^refactor", group = "<!-- 2 --> Refactor" },
+  { message = "^perf", group = "<!-- 3 --> Performance" },
+  { message = "^build", group = "<!-- 4 --> Build" },
+  { message = "^doc", group = "<!-- 5 --> Documentation" },
+  { message = ".*", group = "<!-- 10 --> Other" , skip = true },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+ignore_tags = ".*b.*"
+use_branch_tags  = true

digitalhub-0.10.0b3/.github/workflows/release.yml

@@ -0,0 +1,146 @@
+name: Release on PyPI and GitHub
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: "Release type"
+        required: true
+        default: "tag-num"
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - upgrade-beta
+          - new-beta-major
+          - new-beta-minor
+          - new-beta-patch
+          - final
+      skip-pypi:
+        description: "If true, skip publishing to PyPI"
+        default: false
+        type: boolean
+
+jobs:
+  bumpver-pyproject:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.current-version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install bumpver
+        run: python -m pip install bumpver
+
+      # Evaluate input and bumpver accordingly
+      - name: Execute script bumpver
+        run: ./.github/scripts/bump.sh ${{ inputs.release-type }}
+
+      # Store current version for later use
+      - name: Current version
+        id: current-version
+        run: |
+          ver=$(bumpver show -n --environ | grep CUR | awk '{gsub(/CURRENT_VERSION=/, ""); print}')
+          echo "version=${ver}" >> "$GITHUB_OUTPUT"
+
+      # Commit modifications to pyproject.toml
+      - name: Commit changes
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+          git commit -a -m "bump: new version ${{ steps.current-version.outputs.version }}"
+          git push
+
+  build-n-publish:
+    name: Build and publish
+    if: ${{ !inputs.skip-pypi }}
+    needs: bumpver-pyproject
+    runs-on: ubuntu-latest
+    steps:
+      # Force with ref as https://github.com/orgs/community/discussions/110853
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      # Build wheel to upload
+      - name: Install build and build a binary wheel
+        run: python -m pip install build && python -m build
+
+      # Publish to PyPI
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}
+
+  tag-and-release:
+    name: Tag and release on Github
+    needs: [bumpver-pyproject]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install cliff
+        run: python -m pip install git-cliff
+
+      - name: Generate a changelog
+        env:
+          VERSION: ${{ needs.bumpver-pyproject.outputs.version }}
+          BETA: ${{ inputs.release-type == 'upgrade-beta' || startsWith(inputs.release-type, 'new-beta')}}
+        run: ./.github/scripts/changelog.sh ${{ env.VERSION }} ${{ env.BETA }}
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ needs.bumpver-pyproject.outputs.version }}
+          BETA: ${{ inputs.release-type == 'upgrade-beta' || startsWith(inputs.release-type, 'new-beta')}}
+        with:
+          name: ${{ env.VERSION }}
+          tag_name: ${{ env.VERSION }}
+          body_path: CHANGELOG.md
+          draft: false
+          prerelease: ${{ env.BETA }}
+
+  # Send a trigger to python wrapper repo
+  trigger:
+    runs-on: ubuntu-latest
+    needs: [bumpver-pyproject, build-n-publish]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Trigger Workflow in Another Repository
+        run: |
+          # Set the required variables
+          repo_owner="scc-digitalhub"
+          event_type="trigger-workflow"
+          lib_name="sdk"
+          lib_vers=${{ needs.bumpver-pyproject.outputs.version }}
+          branch=${{ github.ref }}
+
+          # Define the repositories to trigger
+          repos=("digitalhub-sdk-wrapper-kfp" "jupyter-notebook-custom-image" "digitalhub-sdk-wrapper-dbt" )
+
+          # Loop over the repositories and trigger the workflow
+          for repo in "${repos[@]}"; do
+            curl -L \
+                 -X POST \
+                 -H "Accept: application/vnd.github+json" \
+                 -H "Authorization: Bearer ${{ secrets.TRIGGER_PAT }}" \
+                 -H "X-GitHub-Api-Version: 2022-11-28" \
+                 https://api.github.com/repos/$repo_owner/$repo/dispatches \
+                 -d "{\"event_type\": \"$event_type\", \"client_payload\": {\"lib_name\": \"$lib_name\", \"lib_vers\": \"$lib_vers\", \"branch\": \"$branch\"}}"
+          done

digitalhub-0.10.0b3/.github/workflows/run_local_test.yml

@@ -0,0 +1,42 @@
+name: Run Unit Local Test via Pytest
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[dev]
+      - name: Lint with Ruff
+        run: |
+          pip install ruff
+          ruff check --output-format=github .
+        continue-on-error: true
+      - name: Get schema files from core
+        run: |
+          wget https://github.com/scc-digitalhub/digitalhub-core/archive/main.zip
+          7z x main.zip
+          rm main.zip
+          mv digitalhub-core-main/schemas/specs test/local/instances/schemas
+          rm -r digitalhub-core-main
+      - name: Test with pytest
+        run: |
+          coverage run -m pytest test/local -v -s
+      - name: Generate Coverage Report
+        run: |
+          coverage report -m

digitalhub-0.10.0b3/.github/workflows/test_release.yml

@@ -0,0 +1,85 @@
+name: Test release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: "Release type"
+        required: true
+        default: "tag-num"
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - upgrade-beta
+          - new-beta-major
+          - new-beta-minor
+          - new-beta-patch
+          - final
+      skip-pypi:
+        description: "If true, skip publishing to PyPI"
+        default: false
+        type: boolean
+
+jobs:
+  bumpver-pyproject:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.current-version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install bumpver
+        run: python -m pip install bumpver
+
+      # Evaluate input and bumpver accordingly
+      - name: Execute script bumpver
+        run: ./.github/scripts/bump.sh ${{ inputs.release-type }}
+
+      # Store current version for later use
+      - name: Current version
+        id: current-version
+        run: |
+          ver=$(bumpver show -n --environ | grep CUR | awk '{gsub(/CURRENT_VERSION=/, ""); print}')
+          echo "version=${ver}" >> "$GITHUB_OUTPUT"
+
+  tag-and-release:
+    name: Tag and release on Github
+    needs: [bumpver-pyproject]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install cliff
+        run: python -m pip install git-cliff
+
+      - name: Generate a changelog
+        env:
+          VERSION: ${{ needs.bumpver-pyproject.outputs.version }}
+          BETA: ${{ inputs.release-type == 'upgrade-beta' || startsWith(inputs.release-type, 'new-beta')}}
+        run: ./.github/scripts/changelog.sh ${{ env.VERSION }} ${{ env.BETA }}
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ needs.bumpver-pyproject.outputs.version }}
+          BETA: ${{ inputs.release-type == 'upgrade-beta' || startsWith(inputs.release-type, 'new-beta')}}
+        with:
+          name: ${{ env.VERSION }}
+          tag_name: ${{ env.VERSION }}
+          body_path: CHANGELOG.md
+          draft: false
+          prerelease: ${{ env.BETA }}

digitalhub-0.10.0b3/.gitignore

@@ -0,0 +1,167 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+#docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# pylint
+.pylintrc
+.ruff_cache
+TODO
+.vscode
+.DS_STORE

{digitalhub-0.10.0b1 → digitalhub-0.10.0b3}/PKG-INFO

@@ -1,7 +1,8 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.10.0b1
+Version: 0.10.0b3
 Summary: Python SDK for Digitalhub
+Project-URL: Homepage, https://github.com/scc-digitalhub/digitalhub-sdk
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License
                                 Version 2.0, January 2004
@@ -219,44 +220,41 @@ License:                               Apache License
         
         (SIL OPEN FONT LICENSE Version 1.1) The Inter font family (https://github.com/rsms/inter)
         (SIL OPEN FONT LICENSE Version 1.1) The Fira Code font family (https://github.com/tonsky/FiraCode)
-        
-Project-URL: Homepage, https://github.com/scc-digitalhub/digitalhub-sdk
+License-File: LICENSE.txt
 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
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
+Requires-Python: <3.13,>=3.9
 Requires-Dist: boto3
-Requires-Dist: pydantic
-Requires-Dist: sqlalchemy
-Requires-Dist: pyarrow
+Requires-Dist: gitpython>=3
 Requires-Dist: numpy<2
-Requires-Dist: requests
-Requires-Dist: PyYAML
-Requires-Dist: python-dotenv
-Requires-Dist: GitPython>=3
 Requires-Dist: psycopg2-binary
+Requires-Dist: pyarrow
+Requires-Dist: pydantic
+Requires-Dist: python-dotenv
 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: pandas; extra == "full"
-Requires-Dist: mlflow; extra == "full"
-Provides-Extra: pandas
-Requires-Dist: pandas; extra == "pandas"
+Requires-Dist: fsspec; extra == 'full'
+Requires-Dist: mlflow; extra == 'full'
+Requires-Dist: pandas; extra == 'full'
+Requires-Dist: s3fs; extra == 'full'
 Provides-Extra: mlflow
-Requires-Dist: mlflow; extra == "mlflow"
-Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: bumpver; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: moto; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: Sphinx>=7; extra == "docs"
-Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
-Requires-Dist: numpydoc>=1.6; extra == "docs"
+Requires-Dist: mlflow; extra == 'mlflow'
+Provides-Extra: pandas
+Requires-Dist: fsspec; extra == 'pandas'
+Requires-Dist: pandas; extra == 'pandas'
+Requires-Dist: s3fs; extra == 'pandas'
+Description-Content-Type: text/markdown
 
 # Digitalhub Library
 

digitalhub-0.10.0b3/digitalhub/entities/dataitem/_base/entity.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities._commons.enums import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.dataitem._base.spec import DataitemSpec
+    from digitalhub.entities.dataitem._base.status import DataitemStatus
+
+
+class Dataitem(MaterialEntity):
+    """
+    A class representing a dataitem.
+    """
+
+    ENTITY_TYPE = EntityTypes.DATAITEM.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: DataitemSpec,
+        status: DataitemStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+        self.spec: DataitemSpec
+        self.status: DataitemStatus