flowyml-notebook 1.0.0__tar.gz

flowyml_notebook-1.0.0/.github/recovery/last_release_version.txt

@@ -0,0 +1 @@
+1.0.0

flowyml_notebook-1.0.0/.github/workflows/MANUAL_DOCS_PUBLISH.yml

@@ -0,0 +1,78 @@
+name: "Manual Documentation Publish"
+
+on:
+  workflow_dispatch:
+    inputs:
+      RELEASE_VERSION:
+        required: true
+        type: string
+        description: "Release version for documentation"
+      UPDATE_LATEST:
+        required: true
+        type: boolean
+        default: true
+        description: "Update the 'latest' alias to point to this version"
+
+permissions:
+  contents: write
+
+jobs:
+  UPDATE_DOCS:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[docs]"
+
+      - name: Fetch gh-pages branch
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+
+          # Fetch the gh-pages branch
+          git fetch origin gh-pages:gh-pages || echo "No gh-pages branch exists yet"
+
+      - name: Release documentation with mike
+        id: deploy_docs
+        run: |
+          echo "Deploying documentation for version ${{ inputs.RELEASE_VERSION }}"
+
+          # Set up command based on whether to update latest alias
+          if [[ "${{ inputs.UPDATE_LATEST }}" == "true" ]]; then
+            echo "Updating 'latest' alias to point to version ${{ inputs.RELEASE_VERSION }}"
+            COMMAND="mike deploy --push --update-aliases ${{ inputs.RELEASE_VERSION }} latest"
+          else
+            echo "Not updating 'latest' alias"
+            COMMAND="mike deploy --push ${{ inputs.RELEASE_VERSION }}"
+          fi
+
+          # Execute the command
+          $COMMAND
+        continue-on-error: true
+
+      - name: Retry documentation release on failure
+        if: steps.deploy_docs.outcome == 'failure'
+        run: |
+          echo "First documentation deploy attempt failed, retrying..."
+
+          # Force-fetch the latest gh-pages branch
+          git fetch origin gh-pages:gh-pages --force
+
+          # Set up command based on whether to update latest alias
+          if [[ "${{ inputs.UPDATE_LATEST }}" == "true" ]]; then
+            mike deploy --push --update-aliases --force ${{ inputs.RELEASE_VERSION }} latest
+          else
+            mike deploy --push --force ${{ inputs.RELEASE_VERSION }}
+          fi

flowyml_notebook-1.0.0/.github/workflows/MANUAL_PYPI_PUBLISH.yml

@@ -0,0 +1,62 @@
+name: "Manual PyPI Publish"
+
+on:
+  workflow_dispatch:
+    inputs:
+      RELEASE_VERSION:
+        required: true
+        type: string
+        description: "Release version to publish to PyPI"
+
+permissions:
+  contents: write
+
+jobs:
+  PYPI_PUBLISH:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Install project dependencies
+        run: |
+          pip install ".[all]"
+
+      - name: Set version for publishing
+        run: |
+          echo "Setting package version to ${{ inputs.RELEASE_VERSION }}"
+          sed -i "s/^version = .*/version = \"${{ inputs.RELEASE_VERSION }}\"/" pyproject.toml
+
+      - name: Build and publish to PyPI
+        id: publish_pypi
+        run: |
+          python -m build
+          twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        continue-on-error: true
+
+      - name: Retry PyPI publish on failure
+        if: steps.publish_pypi.outcome == 'failure'
+        run: |
+          echo "First attempt failed, retrying..."
+          sleep 10
+          python -m build
+          twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

flowyml_notebook-1.0.0/.github/workflows/PRECOMMITS.yml

@@ -0,0 +1,47 @@
+name: Pre-commit checks
+on:
+  pull_request:
+    branches:
+      - dev
+      - main
+    types:
+      - opened
+      - edited
+      - synchronize
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  pre-commit-checks:
+    runs-on: ["ubuntu-latest"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Check Pull Request Title
+        uses: Slashgear/action-check-pr-title@main
+        with:
+          regexp: '(break|build|ci|docs|feat|fix|perf|refactor|style|test|ops|hotfix)\\([a-z,A-Z,0-9,\\-,\\_,\\/,:]+\\)(:)\\s{1}([\\w\\s]+)' # Regex the title should match.
+      - name: Getting changed files list
+        id: files
+        uses: jitterbit/get-changed-files@master
+      - name: Checking changed files
+        shell: bash
+        run: |
+          echo "Changed files"
+          echo ${{ steps.files.outputs.all }}
+          echo "Github Client version"
+          echo $(gh --version)
+      - name: Pre-Commit Checks
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+          echo "Running pre-commit scans:"
+          # adding log display in case of pre-commit errors
+          pre-commit run -v --files ${{ steps.files.outputs.all }}
+        shell: bash

flowyml_notebook-1.0.0/.github/workflows/PR_PREVIEW.yml

@@ -0,0 +1,55 @@
+name: Deploy PR Pages Preview
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+      - main
+    paths:
+      - "docs/**"
+      - mkdocs.yml
+  pull_request:
+    branches:
+      - dev
+      - main
+    paths:
+      - "docs/**"
+      - mkdocs.yml
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  deploy-pr-preview:
+    runs-on: ["ubuntu-latest"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Python dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[docs]"
+
+      - name: Install and Build
+        shell: bash
+        run: |
+          mkdocs build
+          echo "DOC GENERATED - OK!"
+
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site/
+          token: ${{ secrets.GITHUB_TOKEN }}

flowyml_notebook-1.0.0/.github/workflows/RELEASE.yml

@@ -0,0 +1,226 @@
+name: "Semantic Release"
+
+on:
+  workflow_dispatch:
+    inputs:
+      DRY_RUN:
+        required: false
+        default: false
+        type: boolean
+        description: "Run in dry run mode (no actual release)"
+      RELEASE_VERSION:
+        required: false
+        type: string
+        description: "Manually specify release version (only for manual publish/docs jobs)"
+      SKIP_RELEASE:
+        required: false
+        default: false
+        type: boolean
+        description: "Skip semantic release and use existing version (for recovery)"
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  SEMANTIC_RELEASE:
+    if: ${{ !inputs.SKIP_RELEASE }}
+    runs-on: ubuntu-latest
+    outputs:
+      new_release_version: ${{ steps.semantic-release.outputs.new_release_version }}
+      release_created: ${{ steps.semantic-release.outputs.new_release_published }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install python-semantic-release
+
+      - name: Semantic Release
+        id: semantic-release
+        run: |
+          if [[ "${{ inputs.DRY_RUN }}" == "true" ]]; then
+            echo "Running in dry-run mode"
+            semantic-release version --print
+            echo "new_release_published=false" >> $GITHUB_OUTPUT
+          else
+            semantic-release version
+            if [ $? -eq 0 ]; then
+              VERSION=$(semantic-release version --print)
+              echo "new_release_published=true" >> $GITHUB_OUTPUT
+              echo "new_release_version=$VERSION" >> $GITHUB_OUTPUT
+            else
+              echo "new_release_published=false" >> $GITHUB_OUTPUT
+            fi
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Show release information
+        shell: bash
+        run: |
+          echo "Release created: ${{ steps.semantic-release.outputs.new_release_published }}"
+          echo "New version: ${{ steps.semantic-release.outputs.new_release_version }}"
+
+      - name: Save release version
+        if: steps.semantic-release.outputs.new_release_published == 'true'
+        run: |
+          echo "Saving release version for recovery"
+          mkdir -p .github/recovery
+          echo "${{ steps.semantic-release.outputs.new_release_version }}" > .github/recovery/last_release_version.txt
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          git add .github/recovery/last_release_version.txt
+          git commit -m "chore: save last release version for recovery [skip ci]" || echo "No changes to commit"
+          git push || echo "Failed to push recovery file"
+
+  PYPI_PUBLISH:
+    needs: [SEMANTIC_RELEASE]
+    if: ${{ needs.SEMANTIC_RELEASE.outputs.release_created == 'true' || inputs.SKIP_RELEASE }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 1
+
+      - name: Get version to publish
+        id: get_version
+        run: |
+          if [[ "${{ inputs.SKIP_RELEASE }}" == "true" ]]; then
+            if [[ -n "${{ inputs.RELEASE_VERSION }}" ]]; then
+              echo "Using manually specified version: ${{ inputs.RELEASE_VERSION }}"
+              echo "VERSION=${{ inputs.RELEASE_VERSION }}" >> $GITHUB_OUTPUT
+            else
+              if [[ -f ".github/recovery/last_release_version.txt" ]]; then
+                VERSION=$(cat .github/recovery/last_release_version.txt)
+                echo "Using recovered version: $VERSION"
+                echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+              else
+                echo "ERROR: No version specified and no recovery file found"
+                exit 1
+              fi
+            fi
+          else
+            echo "Using version from semantic-release: ${{ needs.SEMANTIC_RELEASE.outputs.new_release_version }}"
+            echo "VERSION=${{ needs.SEMANTIC_RELEASE.outputs.new_release_version }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Set version for publishing
+        run: |
+          echo "Setting package version to ${{ steps.get_version.outputs.VERSION }}"
+          sed -i "s/^version = .*/version = \"${{ steps.get_version.outputs.VERSION }}\"/" pyproject.toml
+
+      - name: Build and publish to PyPI
+        id: publish_pypi
+        run: |
+          python -m build
+          twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        continue-on-error: true
+
+      - name: Retry PyPI publish on failure
+        if: steps.publish_pypi.outcome == 'failure'
+        run: |
+          echo "First attempt failed, retrying..."
+          sleep 10
+          python -m build
+          twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+
+  UPDATE_DOCS:
+    needs: [SEMANTIC_RELEASE, PYPI_PUBLISH]
+    if: ${{ (needs.SEMANTIC_RELEASE.outputs.release_created == 'true' && !failure('PYPI_PUBLISH')) || inputs.SKIP_RELEASE }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 1
+
+      - name: Get version for docs
+        id: get_docs_version
+        run: |
+          if [[ "${{ inputs.SKIP_RELEASE }}" == "true" ]]; then
+            if [[ -n "${{ inputs.RELEASE_VERSION }}" ]]; then
+              echo "Using manually specified version: ${{ inputs.RELEASE_VERSION }}"
+              echo "VERSION=${{ inputs.RELEASE_VERSION }}" >> $GITHUB_OUTPUT
+            else
+              if [[ -f ".github/recovery/last_release_version.txt" ]]; then
+                VERSION=$(cat .github/recovery/last_release_version.txt)
+                echo "Using recovered version: $VERSION"
+                echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+              else
+                echo "ERROR: No version specified and no recovery file found"
+                exit 1
+              fi
+            fi
+          else
+            echo "Using version from semantic-release: ${{ needs.SEMANTIC_RELEASE.outputs.new_release_version }}"
+            echo "VERSION=${{ needs.SEMANTIC_RELEASE.outputs.new_release_version }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[docs]"
+
+      - name: Fetch gh-pages branch
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+
+          # Fetch the gh-pages branch
+          git fetch origin gh-pages:gh-pages || echo "No gh-pages branch exists yet"
+
+      - name: Release documentation with mike
+        id: deploy_docs
+        run: |
+          echo "Deploying documentation for version ${{ steps.get_docs_version.outputs.VERSION }}"
+
+          # Attempt to deploy docs
+          mike deploy --push --update-aliases ${{ steps.get_docs_version.outputs.VERSION }} latest
+        continue-on-error: true
+
+      - name: Retry documentation release on failure
+        if: steps.deploy_docs.outcome == 'failure'
+        run: |
+          echo "First documentation deploy attempt failed, retrying..."
+
+          # Force-fetch the latest gh-pages branch
+          git fetch origin gh-pages:gh-pages --force
+
+          # Use the version from recovery process
+          mike deploy --push --update-aliases --force ${{ steps.get_docs_version.outputs.VERSION }} latest

flowyml_notebook-1.0.0/.github/workflows/UTESTS.yml

@@ -0,0 +1,131 @@
+name: "Unit-tests"
+
+on:
+  push:
+    branches:
+      - dev
+      - main
+    paths:
+      - "**.py"
+      - "pyproject.toml"
+      - "tests/**"
+  pull_request:
+    branches:
+      - dev
+      - main
+    types:
+      - opened
+      - edited
+      - synchronize
+    paths:
+      - "**.py"
+      - "pyproject.toml"
+      - "tests/**"
+  workflow_dispatch:
+    inputs:
+      PYTHON_VERSION:
+        required: false
+        default: "3.11"
+
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  # Fast smoke test job for quick feedback
+  smoke-test:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[all]"
+          pip install pytest pytest-cov
+      - name: Run smoke tests
+        run: |
+          # Run a quick subset of tests for fast feedback
+          pytest tests/ -v --maxfail=3 --tb=short -x
+        timeout-minutes: 3
+
+  # Main test matrix
+  test-matrix:
+    runs-on: ubuntu-latest
+    needs: [smoke-test]
+    if: always() && (needs.smoke-test.result == 'success' || github.event_name != 'pull_request')
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["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 }}
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[all]"
+          pip install pytest pytest-cov
+
+      - name: Run tests
+        run: |
+          pytest tests/ -v --maxfail=10
+        timeout-minutes: 15
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-${{ matrix.python-version }}
+          path: |
+            pytest.xml
+          retention-days: 7
+
+  # Coverage job (only on main Python version)
+  coverage:
+    runs-on: ubuntu-latest
+    needs: [test-matrix]
+    if: always() && needs.test-matrix.result == 'success'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[all]"
+          pip install pytest pytest-cov
+
+      - name: Run tests with coverage
+        run: |
+          pytest tests/ --cov=flowyml_notebook --cov-report=xml --cov-report=html --cov-report=term-missing -v
+        timeout-minutes: 20
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+        continue-on-error: true
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: htmlcov/
+          retention-days: 30

flowyml_notebook-1.0.0/.gitignore

@@ -0,0 +1,59 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environments
+.venv/
+venv/
+ENV/
+env/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+
+# Frontend
+node_modules/
+/flowyml_notebook/frontend/npm-debug.log*
+
+# Documentation
+site/
+.mkdocs/
+
+# Environment
+.env
+.env.*
+!.env.example
+
+# Tests
+.pytest_cache/
+.coverage
+htmlcov/
+nosetests.xml
+coverage.xml
+*.cover
+.tox/
+.hypothesis/

flowyml_notebook-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+default_language_version:
+  python: python3.12
+
+default_stages: [pre-commit]
+default_install_hook_types: [pre-commit, commit-msg]
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.11
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-yaml
+        args: ["--allow-multiple-documents", "--unsafe"]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-docstring-first
+      - id: check-toml
+      - id: check-added-large-files
+        args: ["--maxkb=1024"]
+      - id: requirements-txt-fixer
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: pretty-format-json
+        args:
+          - "--autofix"
+          - "--indent=2"
+  - repo: local
+    hooks:
+      - id: validate-commit-msg
+        name: Commit Message is Valid
+        language: pygrep
+        entry: ^(break|build|ci|docs|feat|fix|perf|refactor|style|test|ops|hotfix|release|maint|init|enh|revert|reformat)(\([\w.,\-()/]+\))?(!)?\:\s.+$
+        stages: [commit-msg]
+        args: [--negate]