first attempt

Author: andreatgretel

.github/workflows/pack-tutorials.yml

@@ -0,0 +1,67 @@
+name: Pack Tutorials
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  zip_and_upload:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up environment variables
+        id: env_setup
+        run: |
+          echo "SOURCE_FOLDER_PATH=docs/notebooks" >> $GITHUB_ENV
+          echo "TARGET_FOLDER_NAME=data_designer_tutorial" >> $GITHUB_ENV
+          echo "ZIP_FILE_NAME=data_designer_tutorial" >> $GITHUB_ENV
+          
+      - name: Check if source folder exists
+        run: |
+          if [ ! -d "${{ env.SOURCE_FOLDER_PATH }}" ]; then
+            echo "::error::Source Folder '${{ env.SOURCE_FOLDER_PATH }}' not found. Check the input value."
+            exit 1
+          fi
+
+      - name: Rename source folder
+        run: mv ${{ env.SOURCE_FOLDER_PATH }} ${{ env.TARGET_FOLDER_NAME }}
+
+      - name: Zip the target folder
+        run: |
+          zip -r ${{ env.ZIP_FILE_NAME }} ${{ env.TARGET_FOLDER_NAME }}
+          echo "Successfully created ${{ env.ZIP_FILE_NAME }}"
+
+      - name: Find the latest existing release Tag
+        id: get_release
+        run: |
+          gh auth status || echo "GitHub CLI is not authenticated, relying on GITHUB_TOKEN."
+
+          # We use tr -d '\n' to remove the trailing newline for a clean tag string
+          LATEST_TAG=$(gh release view --json tagName -q .tagName 2>/dev/null)
+          
+          if [ -z "$LATEST_TAG" ]; then
+            echo "::error::Could not find the latest published release tag. Ensure a release exists."
+            exit 1
+          fi
+          
+          echo "Latest Release Tag found: $LATEST_TAG"
+          echo "tag=$LATEST_TAG" >> $GITHUB_OUTPUT
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload zip file as release asset
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.get_release.outputs.tag }}
+          files: ${{ env.ZIP_FILE_NAME }}
+          draft: false
+          prerelease: false
+          
+      - name: Cleanup
+        if: always()
+        run: rm -f ${{ env.ZIP_FILE_NAME }}

docs/notebooks/intro.md docs/notebooks/README.mddocs/notebooks/intro.md renamed to docs/notebooks/README.md

@@ -6,21 +6,15 @@ Welcome to the Data Designer tutorial series! These hands-on notebooks will guid
 
 ### Local Setup Best Practices
 
-The notebooks can be downloaded using the link on the top of each of them.
+First, download the tutorial [from the release assets](add-link). 
 To run them locally, we recommend using a virtual environment to manage dependencies:
 
 === "uv (Recommended)"
 
     ```bash
-    # Create a new project directory
-    mkdir data-designer-tutorials
-    cd data-designer-tutorials
-
-    # Initialize a new uv project
-    uv init
-
-    # Add data-designer and jupyter
-    uv add data-designer jupyter
+    # Extract tutorial notebooks
+    unzip data_designer_tutorial.zip
+    cd data_designer_tutorial
 
     # Launch Jupyter
     uv run jupyter notebook
@@ -29,15 +23,13 @@ To run them locally, we recommend using a virtual environment to manage dependen
 === "pip + venv"
 
     ```bash
-    # Create a new project directory
-    mkdir data-designer-tutorials
-    cd data-designer-tutorials
+    # Extract tutorial notebooks
+    unzip data_designer_tutorial.zip
+    cd data_designer_tutorial
 
-    # Create and activate a virtual environment
+    # Create Python virtual environment and install required packages
     python -m venv venv
     source venv/bin/activate
-
-    # Install data-designer and jupyter
     pip install data-designer jupyter
 
     # Launch Jupyter
@@ -117,4 +109,4 @@ Quick reference guides for the main configuration objects:
 - **[column_configs](../code_reference/column_configs.md)** - All column configuration types
 - **[config_builder](../code_reference/config_builder.md)** - The `DataDesignerConfigBuilder` API
 - **[data_designer_config](../code_reference/data_designer_config.md)** - Main configuration schema
-- **[validator_params](../code_reference/validator_params.md)** - Validator configuration options
+- **[validator_params](../code_reference/validator_params.md)** - Validator configuration options

docs/notebooks/pyproject.toml

@@ -0,0 +1,9 @@
+[project]
+name = "data_designer_tutorial"
+version = "0.1.0"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "data-designer==0.1.0",
+    "jupyter>=1.1.1",
+]

mkdocs.yml

@@ -17,7 +17,7 @@ nav:
       - Model Providers: models/model-providers.md
       - Model Configs: models/model-configs.md
   - Tutorials:
-      - Overview: notebooks/intro.md
+      - Overview: notebooks/README.md
       - The Basics: notebooks/1-the-basics.ipynb
       - Structured Outputs and Jinja Expressions: notebooks/2-structured-outputs-and-jinja-expressions.ipynb
       - Seeding with an External Dataset: notebooks/3-seeding-with-a-dataset.ipynb