sparkleframe 0.0.1__tar.gz

sparkleframe-0.0.1/.coverage

@@ -0,0 +1,13 @@
+[run]
+include=
+
+omit=
+    # put your paths here
+    __init__.py
+    *_test.py
+    sparkleframe/conftest.py
+    sparkleframe/activate.py
+    sparkleframe/gpt_utils.py
+    sparkleframe/tests/spark.py
+    sparkleframe/tests/utils.py
+    sparkleframe/polarsdf/types.py

sparkleframe-0.0.1/.docker/Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.11-slim as base
+
+# base
+RUN apt-get update && apt-get install -y apt-utils default-jdk curl wget gcc python3-dev gnupg \
+    software-properties-common && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# spark
+RUN wget https://archive.apache.org/dist/spark/spark-3.5.4/spark-3.5.4-bin-hadoop3.tgz && \
+    tar xf spark-* && \
+    mv spark-3.5.4-bin-hadoop3 /opt/spark && \
+    rm spark-*.tgz
+
+ENV SPARK_HOME "/opt/spark"
+ENV HADOOP_HOME "${SPARK_HOME}"
+ENV PATH "${PATH}:${SPARK_HOME}/bin:${SPARK_HOME}/sbin"
+ENV PYSPARK_PYTHON "/usr/local/bin/python3"
+ENV PYSPARK_DRIVER_PYTHON "${PYSPARK_PYTHON}"
+ENV PYTHONPATH "${PYTHONPATH}:/local:/:"
+
+COPY /sparkleframe /sparkleframe
+ENV PYTHONPATH "${PYTHONPATH}:/local:/sparkleframe:/:"
+
+# requirements
+COPY requirements-dev.txt .
+RUN pip install -r requirements-dev.txt

sparkleframe-0.0.1/.docker/docker-compose.yaml

@@ -0,0 +1,13 @@
+services:
+  sparkleframe:
+    build:
+      context: ../
+      dockerfile: ./.docker/Dockerfile
+    container_name: sparkleframe
+    environment:
+      TIMEZONE: US/Eastern
+    volumes:
+      - ./../sparkleframe:/sparkleframe
+      - ./../.coverage:/sparkleframe/.coverage
+      - ./../pyproject.toml:/pyproject.toml
+      - ./../.pylintrc:/.pylintrc

sparkleframe-0.0.1/.github/actions/setup-dependencies/action.yml

@@ -0,0 +1,17 @@
+# Composite action to setup python and install dependencies
+# Useful for use in various pipelines as we usually have to setup python/dependencies
+
+name: "Setup Dependencies"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install backend requirements
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -r requirements-dev.txt

sparkleframe-0.0.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

sparkleframe-0.0.1/.github/hooks/prepare-commit-msg

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+COMMIT_MSG_FILE="$1"
+COMMIT_SOURCE="$2"
+
+# Skip certain commit types (e.g., merge, squash)
+if [[ "$COMMIT_SOURCE" != "merge" && "$COMMIT_SOURCE" != "squash" ]]; then
+  BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
+
+  # Skip if detached HEAD
+  if [ "$BRANCH_NAME" != "HEAD" ]; then
+    # Read existing message
+    COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")
+
+    # Prepend branch name
+    echo "#$BRANCH_NAME $COMMIT_MSG" > "$COMMIT_MSG_FILE"
+  fi
+fi

sparkleframe-0.0.1/.github/workflows/deploy.yml

@@ -0,0 +1,57 @@
+# Release a new version of SparkleFrame. Changes that take place:
+# -
+# - Documentation is regenerated and a new version added to the docs.
+
+name: 'deploy'
+
+on:
+
+  # Allow for manual invocation
+  workflow_dispatch:
+
+jobs:
+  predeploy:
+    uses: ./.github/workflows/predeploy.yml
+
+  deploy-pypi:
+    needs: predeploy
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    env:
+      FLIT_USERNAME: __token__
+      FLIT_INDEX_URL: https://upload.pypi.org/legacy/
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Dependencies
+        uses: './.github/actions/setup-dependencies'
+      - name: Download version file
+        uses: actions/download-artifact@v4
+        with:
+          name: version.txt
+          path: sparkleframe
+      - name: Store version number
+        run: echo "VERSION_NUMBER=$(cat sparkleframe/version.txt)" >> $GITHUB_ENV
+      - name: Download changelog
+        uses: actions/download-artifact@v4
+        with:
+          name: changelog.md
+      - name: Create new branch
+        run: |
+          git config --global user.email "flypipe@dummy.com"
+          git config --global user.name "flypipe"
+          git checkout -b "release/${{ env.VERSION_NUMBER }}"
+          git add sparkleframe/version.txt
+          git add changelog.md
+          git commit -m 'chore: update version file'
+          git push origin "release/${{ env.VERSION_NUMBER }}"
+      - name: Upload to pypi
+        run: |
+          flit publish
+        env:
+          FLIT_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+
+#  build-docs:
+#    needs: deploy-pypi
+#    uses: ./.github/workflows/build-docs.yml

sparkleframe-0.0.1/.github/workflows/predeploy.yml

@@ -0,0 +1,65 @@
+# Prepare for deployment:
+# - run verification to double check the code quality
+# - calculate the new prospective version
+# - calculate the new prospective changelog
+# By calculating the version/changelog here instead of in the deployment job we can double check these artifacts to
+# ensure they are looking fine prior to releasing.
+
+name: 'prepare-for-deployment'
+
+on:
+  push:
+    branches: [ "main" ]
+
+  # Allow for manual invocation
+  workflow_dispatch:
+
+  # Allow pipeline to be invoked from other pipelines
+  workflow_call:
+
+jobs:
+  verification:
+    uses: ./.github/workflows/verification.yml
+
+  build-wheel:
+    needs: verification
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # We need the full history for calculation of the version number
+          fetch-depth: 0
+      - name: Fetch branches
+        run: git fetch
+      - name: Setup Dependencies
+        uses: './.github/actions/setup-dependencies'
+      - name: Calculate new version number
+        run: |
+          python scripts/calculate_version.py
+          echo "VERSION_NUMBER=$(cat ./sparkleframe/version.txt)" >> $GITHUB_ENV
+          echo ${{ env.VERSION_NUMBER }}
+      - name: Upload version file
+        uses: actions/upload-artifact@v4
+        with:
+          name: version.txt
+          path: ./sparkleframe/version.txt
+      - name: Calculate changelog for new version
+        run: python scripts/generate_changelog.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload changelog file
+        uses: actions/upload-artifact@v4
+        with:
+          name: changelog.md
+          path: ./changelog.md
+      # Build and upload the wheel so we can access the wheel without having to upload it to pypi
+      - name: Build wheel
+        run: flit build --no-use-vcs
+      - name: Upload wheel
+        uses: actions/upload-artifact@v4
+        with:
+          name: sparkleframe-${{ env.VERSION_NUMBER }}-py3-none-any.whl
+          path: ./dist/sparkleframe-${{ env.VERSION_NUMBER }}-py3-none-any.whl

sparkleframe-0.0.1/.github/workflows/verification.yml

@@ -0,0 +1,54 @@
+name: verification
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "**" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+  # Allow pipeline to be invoked from other pipelines
+  workflow_call:
+
+jobs:
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # Fetch all tags/branches to run diff-cover properly
+          fetch-depth: 0
+      - name: Setup docker compose
+        run: |
+          curl -L https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
+          chmod +x /usr/local/bin/docker-compose
+          docker-compose version
+      - name: Setup dependencies
+        uses: ./.github/actions/setup-dependencies
+      - name: Run unit tests for scripts (calculate wheel version and changelogs)
+        run: pytest scripts/*_test.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Package version number (preview)
+        run: |
+          python scripts/calculate_version.py
+      - name: Changelog (preview)
+        run: python scripts/generate_changelog.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run formatter on backend (black)
+        run: make black-check
+      - name: Run linter (ruff)
+        run: make lint
+      - name: Run unit tests
+        run: make coverage

sparkleframe-0.0.1/.gitignore

@@ -0,0 +1,174 @@
+# 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/
+/sparkleframe/.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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc