fabric-arcade 0.1.0__tar.gz

fabric_arcade-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,181 @@
+# Fabric Arcade - CI Workflow
+# Runs tests, linting, and type checking on every push and PR
+
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+env:
+  PYTHON_VERSION: "3.11"
+
+jobs:
+  # ============================================
+  # Lint and Type Check
+  # ============================================
+  lint:
+    name: 🔍 Lint & Type Check
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+
+      - name: 📦 Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff mypy
+          pip install -e ".[dev]"
+
+      - name: 🔍 Run Ruff linter
+        run: ruff check fabric_arcade/
+
+      - name: 📐 Run Ruff formatter check
+        run: ruff format --check fabric_arcade/
+
+      - name: 🔬 Run MyPy type check
+        run: mypy fabric_arcade/ --ignore-missing-imports
+
+  # ============================================
+  # Unit Tests
+  # ============================================
+  test:
+    name: 🧪 Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: 📥 Checkout code
+        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 -e ".[dev]"
+
+      - name: 🧪 Run pytest
+        run: |
+          pytest tests/ -v --cov=fabric_arcade --cov-report=xml --cov-report=term
+
+      - name: 📊 Upload coverage to Codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  # ============================================
+  # Build Package
+  # ============================================
+  build:
+    name: 📦 Build Package
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: 📦 Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: 🏗️ Build package
+        run: python -m build
+
+      - name: ✅ Check package
+        run: twine check dist/*
+
+      - name: 📤 Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 5
+
+  # ============================================
+  # Validate Catalog
+  # ============================================
+  validate-catalog:
+    name: 📋 Validate Game Catalog
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: 📦 Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+
+      - name: 📋 Validate catalog entries
+        run: |
+          python -c "
+          from fabric_arcade.catalog import get_catalog, get_game
+          
+          print('🎮 Validating Fabric Arcade Catalog...')
+          print('=' * 50)
+          
+          catalog = get_catalog()
+          print(f'Total games: {len(catalog)}')
+          
+          for game in catalog:
+              print(f'  ✅ {game.icon} {game.name} ({game.id})')
+              # Validate game can be retrieved
+              assert get_game(game.id) is not None
+          
+          print('=' * 50)
+          print('✅ All catalog entries valid!')
+          "
+
+      - name: 📋 Validate manifest files
+        run: |
+          python -c "
+          import json
+          from pathlib import Path
+          
+          print('📋 Validating manifest.json files...')
+          
+          catalog_dir = Path('catalog')
+          for manifest_path in catalog_dir.glob('*/manifest.json'):
+              with open(manifest_path) as f:
+                  manifest = json.load(f)
+              
+              required_fields = ['id', 'name', 'version', 'type', 'workloads']
+              for field in required_fields:
+                  assert field in manifest, f'Missing {field} in {manifest_path}'
+              
+              print(f'  ✅ {manifest_path}')
+          
+          print('✅ All manifests valid!')
+          "

fabric_arcade-0.1.0/.github/workflows/preview.yml

@@ -0,0 +1,45 @@
+# Fabric Arcade - PR Preview Workflow
+# Deploys preview of website changes for PRs
+
+name: PR Preview
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'website/**'
+      - 'catalog/**'
+      - 'docs/**'
+
+jobs:
+  preview:
+    name: 🔍 Deploy Preview
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: read
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🏗️ Build preview
+        run: |
+          mkdir -p preview
+          cp -r website/* preview/
+
+      - name: 🚀 Deploy to Netlify
+        uses: nwtgck/actions-netlify@v2
+        with:
+          publish-dir: './preview'
+          production-deploy: false
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message: "PR Preview for #${{ github.event.pull_request.number }}"
+          enable-pull-request-comment: true
+          enable-commit-comment: false
+          overwrites-pull-request-comment: true
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 5
+        continue-on-error: true  # Don't fail if Netlify not configured

fabric_arcade-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,193 @@
+# Fabric Arcade - Release & Deploy Workflow
+# Publishes to PyPI and deploys website on release
+
+name: Release & Deploy
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      deploy_website:
+        description: 'Deploy website only'
+        type: boolean
+        default: false
+      publish_pypi:
+        description: 'Publish to PyPI'
+        type: boolean
+        default: false
+
+env:
+  PYTHON_VERSION: "3.11"
+
+jobs:
+  # ============================================
+  # Publish to PyPI
+  # ============================================
+  publish-pypi:
+    name: 📦 Publish to PyPI
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' || inputs.publish_pypi
+    environment:
+      name: pypi
+      url: https://pypi.org/project/fabric-arcade/
+    permissions:
+      id-token: write  # For trusted publishing
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: 📦 Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: 🏗️ Build package
+        run: python -m build
+
+      - name: 📤 Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses trusted publishing - no token needed
+
+  # ============================================
+  # Deploy Website to GitHub Pages
+  # ============================================
+  deploy-website:
+    name: 🌐 Deploy Website
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' || inputs.deploy_website
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🔧 Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: 📦 Build website
+        run: |
+          # Copy website files
+          mkdir -p _site
+          cp -r website/* _site/
+          
+          # Generate game pages from catalog
+          python -c "
+          import json
+          from pathlib import Path
+          
+          # Create games directory
+          games_dir = Path('_site/games')
+          games_dir.mkdir(exist_ok=True)
+          
+          # Generate page for each game
+          catalog_dir = Path('catalog')
+          for game_dir in catalog_dir.iterdir():
+              if not game_dir.is_dir():
+                  continue
+              
+              readme = game_dir / 'README.md'
+              manifest = game_dir / 'manifest.json'
+              
+              if readme.exists() and manifest.exists():
+                  with open(manifest) as f:
+                      meta = json.load(f)
+                  
+                  # Create simple redirect/info page
+                  html = f'''<!DOCTYPE html>
+          <html>
+          <head>
+              <title>{meta['name']} - Fabric Arcade</title>
+              <meta http-equiv=\"refresh\" content=\"0; url=../docs/{meta['id']}.html\">
+              <link rel=\"stylesheet\" href=\"../css/style.css\">
+          </head>
+          <body>
+              <div style=\"text-align:center; padding:50px;\">
+                  <h1>{meta.get('icon', '🎮')} {meta['name']}</h1>
+                  <p>Redirecting to documentation...</p>
+              </div>
+          </body>
+          </html>'''
+                  
+                  (games_dir / f\"{meta['id']}.html\").write_text(html)
+                  print(f'  ✅ Generated {meta[\"id\"]}.html')
+          "
+
+      - name: 📤 Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+      - name: 🚀 Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+  # ============================================
+  # Create GitHub Release Assets
+  # ============================================
+  release-assets:
+    name: 📎 Upload Release Assets
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    permissions:
+      contents: write
+
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: 📦 Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: 📋 Create catalog bundle
+        run: |
+          # Create a zip of the catalog for offline use
+          zip -r fabric-arcade-catalog.zip catalog/
+
+      - name: 📤 Upload release assets
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+            fabric-arcade-catalog.zip
+
+  # ============================================
+  # Notify on Success
+  # ============================================
+  notify:
+    name: 📢 Notify
+    runs-on: ubuntu-latest
+    needs: [publish-pypi, deploy-website]
+    if: always() && github.event_name == 'release'
+
+    steps:
+      - name: 📢 Post release summary
+        run: |
+          echo "## 🎮 Fabric Arcade Release Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Version:** ${{ github.event.release.tag_name }}" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "### Links" >> $GITHUB_STEP_SUMMARY
+          echo "- 📦 [PyPI Package](https://pypi.org/project/fabric-arcade/)" >> $GITHUB_STEP_SUMMARY
+          echo "- 🌐 [Website](https://fabricarcade.github.io/fabric-arcade/)" >> $GITHUB_STEP_SUMMARY
+          echo "- 📚 [Documentation](https://fabricarcade.github.io/fabric-arcade/docs/)" >> $GITHUB_STEP_SUMMARY

fabric_arcade-0.1.0/.github/workflows/static.yml

@@ -0,0 +1,46 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact      
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './website'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5
+
+
+

fabric_arcade-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# MyPy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Netlify
+.netlify/

fabric_arcade-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,153 @@
+# Contributing to Fabric Arcade 🎮
+
+Grazie per voler contribuire a Fabric Arcade! Questo documento spiega come creare nuovi giochi per il catalogo.
+
+## 🎯 Tipi di Contributi
+
+### 1. Nuovo Gioco
+Crea un nuovo progetto gamificato per imparare Fabric.
+
+### 2. Miglioramento Gioco Esistente
+Aggiungi feature, correggi bug, o migliora la documentazione.
+
+### 3. Traduzione
+Traduci i giochi in altre lingue.
+
+## 🎮 Creare un Nuovo Gioco
+
+### Step 1: Scegli il Tipo
+
+| Tipo | Durata | Complessità | Ideale per |
+|------|--------|-------------|------------|
+| **Mission** | 30-60 min | Multi-workload | Scenari completi end-to-end |
+| **Challenge** | 15-30 min | Singolo workload | Focus su skill specifiche |
+| **Arcade** | 5-15 min | Beginner | Demo rapide e divertenti |
+
+### Step 2: Definisci la Storia
+
+Ogni gioco deve avere:
+- **Tema accattivante**: Spazio, sport, fantasy, simulazione...
+- **Obiettivo chiaro**: Cosa costruisce l'utente?
+- **Progressione**: Capitoli/livelli con difficoltà crescente
+- **Achievement**: Badge per motivare il completamento
+
+### Step 3: Struttura Cartelle
+
+```
+catalog/
+└── my-game-name/
+    ├── manifest.json      # Metadata obbligatorio
+    ├── README.md          # Documentazione gioco
+    ├── architecture.svg   # Diagramma architettura
+    ├── notebooks/
+    │   ├── 01_setup.py
+    │   ├── 02_main.py
+    │   └── 03_analysis.py
+    ├── definitions/       # Fabric item definitions (opzionale)
+    │   ├── eventhouse.json
+    │   └── eventstream.json
+    ├── data/
+    │   └── sample_data.json
+    └── assets/
+        └── game_icon.png
+```
+
+### Step 4: Crea il manifest.json
+
+```json
+{
+    "$schema": "https://arcade.fabric.example.com/schemas/game-manifest-v1.json",
+    "id": "my-game-name",
+    "name": "My Game Name",
+    "version": "1.0.0",
+    "description": "Brief description of what players will learn and build",
+    "type": "mission|challenge|arcade",
+    "workloads": ["RTI", "DE", "PBI", "DS", "DF", "DW"],
+    "difficulty": 1-3,
+    "duration_minutes": 15-60,
+    "icon": "🎮",
+    "tags": ["tag1", "tag2"],
+    "prerequisites": {
+        "fabric_capacity": "F2",
+        "python_packages": [],
+        "skills": []
+    },
+    "learning_objectives": [
+        "Objective 1",
+        "Objective 2"
+    ],
+    "achievements": [
+        {
+            "id": "achievement-id",
+            "name": "Achievement Name",
+            "description": "How to earn it",
+            "icon": "🏆"
+        }
+    ],
+    "items": [
+        {
+            "type": "Eventhouse|Eventstream|Notebook|etc",
+            "name": "item-name",
+            "description": "What this item does"
+        }
+    ],
+    "story": {
+        "intro": "The narrative hook",
+        "chapters": [
+            {
+                "title": "Chapter 1",
+                "description": "What happens in this chapter"
+            }
+        ]
+    }
+}
+```
+
+### Step 5: Scrivi la Documentazione
+
+Il README.md deve includere:
+
+1. **Titolo e Badge** - Nome, difficoltà, durata, workload
+2. **Storia/Briefing** - Il contesto narrativo
+3. **Learning Objectives** - Cosa impareranno
+4. **Prerequisites** - Requisiti tecnici
+5. **Quick Start** - Come installare e avviare
+6. **Capitoli Dettagliati** - Guide step-by-step con codice
+7. **Achievement** - Badge guadagnabili
+8. **Architettura** - Diagramma ASCII o SVG
+9. **Risorse** - Link a documentazione Fabric
+
+### Step 6: Crea i Notebook
+
+Linee guida per i notebook:
+- Usa celle magic `%md` per spiegazioni
+- Includi output di esempio dove possibile
+- Aggiungi emoji per rendere visivamente accattivante
+- Testa su Fabric prima di committare
+
+## 📋 Checklist Pre-Submit
+
+- [ ] manifest.json valido
+- [ ] README.md completo
+- [ ] Tutti i notebook testati su Fabric
+- [ ] Nessuna credenziale hardcoded
+- [ ] Achievement definiti
+- [ ] Diagramma architettura incluso
+
+## 🔍 Code Review
+
+Il tuo PR sarà revisionato per:
+- Correttezza tecnica
+- Qualità della narrazione
+- Completezza della documentazione
+- Test funzionali
+
+## 📜 Licenza
+
+Contribuendo accetti che il tuo codice sia rilasciato sotto licenza MIT.
+
+---
+
+**Domande?** Apri una Issue o contattaci su Discord!
+
+*"Every game makes Fabric more fun to learn!"* 🎮

fabric_arcade-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fabric Gaming Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.