Update .gitignore to exclude PyPI build artifacts and enhance README with instructions for using the judge in Google Colab and publishing to PyPI. Modify setup.py to restrict package inclusion to only torch_judge for PyPI distribution.

Author: duoan

.github/workflows/pypi-publish.yml

@@ -0,0 +1,48 @@
+# Publish torch-judge to PyPI when a version tag (v*) is pushed, or manually.
+#
+# Setup (choose one):
+#
+# 1) Trusted Publishing (recommended, no token):
+#    - On PyPI: Project → Publishing → Add a new pending publisher
+#    - Owner: duoan (or your org), Repository: TorchCode, Workflow: pypi-publish.yml
+#    - Then run this workflow once; PyPI will link the publisher.
+#
+# 2) API token:
+#    - Add repository secret PYPI_API_TOKEN (value = pypi-... from pypi.org)
+#    - The action will use TWINE_USERNAME=__token__ and TWINE_PASSWORD from secret.
+
+name: Publish torch-judge to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # for PyPI trusted publishing (OIDC)
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true

.gitignore

@@ -7,6 +7,11 @@ data/*.db
 .DS_Store
 notebooks/
 
+# PyPI build artifacts
+dist/
+build/
+.venv/
+
 # JupyterLab extension build artifacts
 labextension/lib/
 labextension/node_modules/

README.md

@@ -65,6 +65,23 @@ No cloud. No signup. No GPU needed. Just `make run` — or try it instantly on H
 
 Or open any problem directly in Google Colab — every notebook has an [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/duoan/TorchCode/blob/master/templates/01_relu.ipynb) badge.
 
+### Option 0b — Use the judge in Colab (pip)
+
+In Google Colab, install the judge from PyPI so you can run `check(...)` without cloning the repo:
+
+```bash
+!pip install torch-judge
+```
+
+Then in a notebook cell:
+
+```python
+from torch_judge import check, status, hint, reset_progress
+status()           # list all problems and your progress
+check("relu")      # run tests for the "relu" task
+hint("relu")       # show a hint
+```
+
 ### Option 1 — Pull the pre-built image (fastest)
 
 ```bash
@@ -260,6 +277,35 @@ No registration needed. The judge picks it up automatically.
 
 ---
 
+## 📦 Publishing `torch-judge` to PyPI (maintainers)
+
+The judge is published as a separate package so Colab/users can `pip install torch-judge` without cloning the repo.
+
+### Automatic (GitHub Action)
+
+Pushing a **version tag** (e.g. `v0.1.0`) triggers [`.github/workflows/pypi-publish.yml`](.github/workflows/pypi-publish.yml), which builds and uploads to PyPI.
+
+1. **Bump version** in `pyproject.toml` (e.g. `version = "0.1.1"`).
+2. **Configure PyPI Trusted Publisher** (one-time):
+   - PyPI → Your project **torch-judge** → **Publishing** → **Add a new pending publisher**
+   - Owner: `duoan`, Repository: `TorchCode`, Workflow: `pypi-publish.yml`, Environment: (leave empty)
+   - Run the workflow once (push a tag or **Actions → Publish torch-judge to PyPI → Run workflow**); PyPI will then link the publisher.
+3. **Release**: `git tag v0.1.1 && git push origin v0.1.1` (tag must match the version in `pyproject.toml`).
+
+Alternatively, use an API token: add repository secret `PYPI_API_TOKEN` (value = `pypi-...` from PyPI) and set `TWINE_USERNAME=__token__` and `TWINE_PASSWORD` from that secret in the workflow if you prefer not to use Trusted Publishing.
+
+### Manual
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+Version is in `pyproject.toml`; bump it before each release.
+
+---
+
 ## ❓ FAQ
 
 <details>

pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "torch-judge"
+version = "0.1.0"
+description = "PyTorch coding judge for Jupyter — check implementations against test cases (TorchCode)."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "duoan" }
+]
+keywords = ["pytorch", "jupyter", "notebook", "judge", "torchcode", "interview", "practice"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Education",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "torch>=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "twine",
+]
+
+[tool.setuptools.packages.find]
+include = ["torch_judge*"]
+exclude = ["labextension*", "scripts*", "templates*", "solutions*", "jupyter_config*"]

setup.py

@@ -1,8 +1,9 @@
 from setuptools import setup, find_packages
 
+# Only ship torch_judge for PyPI; rest of repo (labextension, templates, etc.) stays local.
 setup(
     name="torch_judge",
     version="0.1.0",
-    packages=find_packages(),
+    packages=find_packages(include=["torch_judge", "torch_judge.*"]),
     python_requires=">=3.10",
 )