Add PyPI publish workflow

Author: ankitdutta428

.env.example

@@ -0,0 +1,14 @@
+# =============================================================================
+# PyDebFlow Environment Variables
+# =============================================================================
+# Copy this file to .env and fill in your values
+# NEVER commit the .env file to version control!
+# =============================================================================
+
+# PyPI API Token for publishing
+# Get this from: https://pypi.org/manage/account/token/
+PYPI_API_TOKEN=pypi-your_token_here
+
+# TestPyPI API Token for test publishing (optional)
+# Get this from: https://test.pypi.org/manage/account/token/
+TEST_PYPI_API_TOKEN=pypi-your_test_token_here

.github/workflows/publish.yml

@@ -0,0 +1,98 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  # =========================================================================
+  # Job 1: Run ALL tests (including API tests)
+  # =========================================================================
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true  # Stop immediately if any test fails
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        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 }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest pytest-cov
+
+      - name: Run ALL tests (library, API, scripts, integration)
+        run: |
+          python -m pytest tests/ -v --tb=short
+          
+      - name: Verify package imports
+        run: |
+          python -c "from src.core.flow_model import TwoPhaseFlowModel; print('Import OK')"
+
+  # =========================================================================
+  # Job 2: Build the package (only if ALL tests pass)
+  # =========================================================================
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Verify package
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  # =========================================================================
+  # Job 3: Publish directly to PyPI (no TestPyPI)
+  # =========================================================================
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pydebflow
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -144,7 +144,23 @@ PyDebFlow implements a **two-phase (solid + fluid) shallow water model** with ad
 - **pip** package manager
 - **Git** (for cloning)
 
-### Method 1: Quick Install with Scripts (Recommended)
+### Method 1: Install from PyPI (Easiest)
+
+```bash
+# Basic installation
+pip install pydebflow
+
+# With visualization support (3D viewer, animations)
+pip install pydebflow[visualization]
+
+# With GUI support
+pip install pydebflow[gui]
+
+# Full installation (all features)
+pip install pydebflow[all]
+```
+
+### Method 2: Quick Install with Scripts
 
 ```bash
 # Clone the repository