Add release pipeline

.github/workflows/pre-release.yaml

@@ -0,0 +1,49 @@
+name: 🍦 Create Pre-Release
+
+on:
+  pull_request:
+    branches:
+      - develop
+    types:
+      - closed
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+jobs:
+  release:
+    if: ${{ github.event.pull_request.merged }}
+    name: 🏗️ Build package and publish to pypi
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nicemldashboard
+    steps:
+      - name: ⬇️ Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: 'develop'
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: 🐍Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: 🚀 Python Semantic Release
+        id: release
+        uses: python-semantic-release/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🐍 Publish package distributions to PyPI
+        uses: pypa/[email protected]
+        if: steps.release.outputs.released == 'true'
+
+      - name: 🐙 Publish package distributions to GitHub Releases
+        uses: python-semantic-release/[email protected]
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yaml

@@ -0,0 +1,49 @@
+name: 🍦 Create Release
+
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - closed
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+jobs:
+  release:
+    if: ${{ github.event.pull_request.merged }}
+    name: 🏗️ Build package and publish to pypi
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nicemldashboard
+    steps:
+      - name: ⬇️ Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: 'main'
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: 🐍Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: 🚀 Python Semantic Release
+        id: release
+        uses: python-semantic-release/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🐍 Publish package distributions to PyPI
+        uses: pypa/[email protected]
+        if: steps.release.outputs.released == 'true'
+
+      - name: 🐙 Publish package distributions to GitHub Releases
+        uses: python-semantic-release/[email protected]
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yaml

@@ -5,6 +5,7 @@ on:
     types: [ opened, reopened, synchronize ]
   workflow_call:
 permissions:
+  id-token: write
   contents: write
   checks: write
   pull-requests: write
@@ -13,8 +14,8 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: [ "3.9", "3.10", "3.11"]
-        os: [ ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     timeout-minutes: 30
     name: 🧪 Run pytests
@@ -25,25 +26,40 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: 🔨 Setup poetry
-        uses: abatilo/actions-poetry@v2
+      - name: 🔨Install rye
+        uses: eifinger/setup-rye@v4
         with:
-          poetry-version: "1.7.1"
-      - name: 🧙 Install dependencies
+          enable-cache: true
+      - name: 🔨Install chrome driver
+        uses: browser-actions/setup-chrome@v1
+        with:
+          chrome-version: '128'
+          install-chromedriver: true
+      - name: 🔨Install dependencies (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          rye pin ${{ matrix.python-version }}
+          rye lock --update-all
+          rye sync
+        shell: cmd
+      - name: 🔨Install dependencies (Unix)
+        if: runner.os != 'Windows'
         run: |
-          poetry config virtualenvs.create false
-          poetry install --no-interaction --with dev --no-ansi
+          rye pin ${{ matrix.python-version }}
+          rye lock --update-all
+          rye sync
+        shell: bash
       - run: mkdir results && touch results/test-results-${{ matrix.python-version }}-${{matrix.os}}-summary.md
       - name: 🧪 Run tests
-        uses: aiakide/pytest-summary@main
+        uses: aiakide/pytest-summary@rye
         with:
-          extensions: pytest-cov
+          extensions: pytest-cov icecream selenium pytest-selenium
           options: --doctest-modules --cov-report term --cov-report xml:coverage-${{ matrix.python-version }}-${{matrix.os}}.xml --cov=nicemldashboard
           paths: tests/**
           output: test-results-${{ matrix.python-version }}-${{matrix.os}}-summary.md
           show: "fail, skip"
       - name: ⬆️ Upload pytest results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.gitignore

@@ -2,9 +2,15 @@
 poetry.toml
 .venv
 
+.python-version
+
 
 **/__pycache__/
 
 .DS_Store
 
 experiments/
+
+experiment_cache/
+
+screenshots/

.pre-commit-config.yaml

@@ -1,32 +1,37 @@
 repos:
-- repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.264
-  hooks:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
+    hooks:
     - id: ruff
-- repo: https://github.com/PyCQA/bandit
-  rev: 1.7.5
-  hooks:
-  - id: bandit
-    exclude: ^tests/
-- repo: https://github.com/psf/black
-  rev: 23.3.0
-  hooks:
-  - id: black
-- repo: https://github.com/Lucas-C/pre-commit-hooks-safety
-  rev: v1.3.1
-  hooks:
-  - id: python-safety-dependencies-check
-    args: ["--ignore=42194,43975,47833,44487,45356,43975,51668"]
-    files: pyproject.toml
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
-  hooks:
-  - id: check-yaml
-    types: [yaml]
-  - id: check-json
-    types: [json]
-  - id: check-toml
-    types: [toml]
-  - id: no-commit-to-branch
-    args: ["--branch", "main"]
-  - id: end-of-file-fixer
+      name: Ruff check
+      description: "Run 'ruff check' for extremely fast Python linting"
+      args: [ --fix ]
+    - id: ruff-format
+      name: Ruff format
+      description: "Run 'ruff format' for extremely fast Python formatting"
+  - repo: https://github.com/hadolint/hadolint
+    rev: v2.12.0
+    hooks:
+      - id: hadolint
+        name: Lint Dockerfiles
+        description: Runs hadolint to lint Dockerfiles
+        language: system
+        types: ["dockerfile"]
+        entry: hadolint
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.5
+    hooks:
+    - id: bandit
+      exclude: ^tests/
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: check-yaml
+      types: [yaml]
+    - id: check-json
+      types: [json]
+    - id: check-toml
+      types: [toml]
+    - id: no-commit-to-branch
+      args: ["--branch", "main"]
+    - id: end-of-file-fixer

.python-version

@@ -0,0 +1 @@
+3.10.14

README.md

@@ -1,2 +1,10 @@
 # niceml-dashboard
  - Welcome on board.
+
+## Getting Started
+We use [rye](https://rye.astral.sh) to manage our dependencies. 
+To start developing niceml-dashboard [install rye](https://rye.astral.sh/guide/installation/) on your system. 
+Then run the following command so that rye creates a virtual environment with all the required dependencies. 
+```bash
+rye sync
+```