DX: define developer environment with uv (#11)

Co-authored-by: GitHub <[email protected]>

.binder/postBuild

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -ex
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source $HOME/.cargo/env
+uv export \
+  --extra jupyter \
+  > requirements.txt
+uv pip install \
+  --requirement requirements.txt \
+  --system
+uv cache clean

.binder/runtime.txt

@@ -0,0 +1 @@
+python-3.12

.editorconfig

@@ -13,5 +13,5 @@ indent_size = unset
 [*.{py,toml}]
 indent_size = 4
 
-[setup.cfg]
+[uv.lock]
 indent_size = 4

.envrc

@@ -1 +1,2 @@
-layout anaconda
+uv sync --all-extras --quiet
+source .venv/bin/activate

.github/workflows/ci.yml

@@ -1,5 +1,13 @@
 name: CI
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+env:
+  PYTHONHASHSEED: "0"
+
 on:
   push:
     branches:
@@ -12,9 +20,15 @@ on:
       - epic/*
       - "[0-9]+.[0-9]+.x"
   workflow_dispatch:
+    inputs:
+      specific-pip-packages:
+        description: Run CI with specific pip packages
+        required: false
+        type: string
 
 jobs:
   style:
+    if: inputs.specific-pip-packages == ''
     secrets:
       token: ${{ secrets.PAT }}
-    uses: ComPWA/actions/.github/workflows/pre-commit.yml@v1
+    uses: ComPWA/actions/.github/workflows/pre-commit.yml@v2

.github/workflows/clean-caches.yml

@@ -14,9 +14,9 @@ on:
 jobs:
   cleanup:
     name: Remove caches
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
-      - uses: ComPWA/actions/clean-caches@v1
+      - uses: ComPWA/actions/clean-caches@v2
         with:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           ref: ${{ inputs.ref }}

.github/workflows/lock.yml

@@ -0,0 +1,22 @@
+name: Update
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+on:
+  pull_request:
+    branches:
+      - main
+      - epic/*
+    paths:
+      - .pre-commit-config.yaml
+      - uv.lock
+  workflow_dispatch:
+
+jobs:
+  lock:
+    uses: ComPWA/actions/.github/workflows/lock.yml@v2
+    secrets:
+      token: ${{ secrets.PAT }}

.github/workflows/pr-linting.yml

@@ -0,0 +1,14 @@
+name: PR linting
+on:
+  pull_request:
+    types:
+      - edited
+      - labeled
+      - opened
+      - reopened
+      - synchronize
+      - unlabeled
+
+jobs:
+  lint-pr:
+    uses: ComPWA/actions/.github/workflows/pr-linting.yml@v2

.gitignore

@@ -3,5 +3,4 @@ build/
 *.egg-info/
 *.svg
 benchmark-results/
-condaenv.*.requirements.txt
 node_modules/

.pre-commit-config.yaml

@@ -1,10 +1,9 @@
 ci:
-  autoupdate_commit_msg: "MAINT: autoupdate pre-commit hooks"
-  autoupdate_schedule: quarterly # already done by requirements-cron.yml
+  autoupdate_commit_msg: "MAINT: update lock files"
+  autoupdate_schedule: quarterly
   skip:
-    - prettier
     - pyright
-    - taplo
+    - uv-lock
 
 repos:
   - repo: meta
@@ -13,21 +12,18 @@ repos:
       - id: check-useless-excludes
 
   - repo: https://github.com/ComPWA/policy
-    rev: 0.3.18
+    rev: 0.5.0
     hooks:
       - id: colab-toc-visible
       - id: check-dev-files
         args:
-          - --dev-python-version=3.12
-          - --no-github-actions
-          - --no-gitpod
-          - --no-prettierrc
+          - --no-cd
           - --no-pypi
           - --repo-name=jax-mini-benchmark
       - id: remove-empty-tags
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.6
+    rev: v0.7.0
     hooks:
       - id: ruff
         args: [--fix]
@@ -36,7 +32,7 @@ repos:
         types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-ast
       - id: check-case-conflict
@@ -49,15 +45,15 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.8
+  - repo: https://github.com/ComPWA/prettier-pre-commit
+    rev: v3.3.3
     hooks:
       - id: prettier
 
-  - repo: https://github.com/ComPWA/mirrors-taplo
-    rev: v0.8.1
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
     hooks:
-      - id: taplo
+      - id: taplo-format
 
   - repo: https://github.com/pappasam/toml-sort
     rev: v0.23.1
@@ -67,7 +63,7 @@ repos:
           - --in-place
 
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 2.7.3
+    rev: 3.0.3
     hooks:
       - id: editorconfig-checker
         name: editorconfig
@@ -77,7 +73,12 @@ repos:
             .*\.py
           )$
 
-  - repo: https://github.com/ComPWA/mirrors-pyright
-    rev: v1.1.374
+  - repo: https://github.com/ComPWA/pyright-pre-commit
+    rev: v1.1.385
     hooks:
       - id: pyright
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.4.24
+    hooks:
+      - id: uv-lock

.python-version

@@ -0,0 +1 @@
+3.12

.vscode/extensions.json

@@ -4,7 +4,9 @@
     "eamodio.gitlens",
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
+    "github.vscode-github-actions",
     "github.vscode-pull-request-github",
+    "mhutchie.git-graph",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "ms-toolsai.jupyter",

.vscode/settings.json

@@ -22,12 +22,14 @@
     "notebook.source.organizeImports": "explicit"
   },
   "notebook.formatOnSave.enabled": true,
-  "python.analysis.typeCheckingMode": "strict",
   "python.terminal.activateEnvironment": false,
   "redhat.telemetry.enabled": false,
   "rewrap.wrappingColumn": 88,
   "ruff.enable": true,
   "ruff.importStrategy": "fromEnvironment",
   "ruff.organizeImports": true,
+  "search.exclude": {
+    "**/uv.lock": true
+  },
   "telemetry.telemetryLevel": "off"
 }

README.md

@@ -1,6 +1,7 @@
 # Mini benchmark for JAX
 
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 This package provides a set of benchmark scripts that can be used to profile JAX performance on a varying number of CPU cores. JAX does not provide control over the number of cores it uses, so a common trick is to work do this with [`taskset`](https://man7.org/linux/man-pages/man1/taskset.1.html).

pyproject.toml

@@ -9,20 +9,6 @@ requires = [
 authors = [
     {name = "Common Partial Wave Analysis", email = "[email protected]"},
 ]
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
-    "Natural Language :: English",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python",
-    "Topic :: Software Development",
-    "Typing :: Typed",
-]
 dependencies = [
     "PyYAML",
     "jax",
@@ -47,7 +33,7 @@ maintainers = [
     {name = "Common Partial Wave Analysis", email = "[email protected]"},
 ]
 name = "jax-mini-benchmark"
-requires-python = ">=3.9"
+requires-python = ">=3.12"
 
 [project.optional-dependencies]
 dev = [
@@ -64,7 +50,7 @@ jupyter = [
     "python-lsp-server[rope]",
 ]
 sty = [
-    "pre-commit",
+    "pre-commit-uv",
     "ruff",
 ]
 
@@ -88,6 +74,8 @@ jax_benchmark = ["py.typed"]
 where = ["src"]
 
 [tool.setuptools_scm]
+local_scheme = "no-local-version"
+version_scheme = "only-version"
 write_to = "src/jax_benchmark/_version.py"
 
 [tool.pyright]
@@ -98,6 +86,7 @@ exclude = [
     "**/.mypy_cache",
     "**/.pytest_cache",
     "**/.tox",
+    "**/.venv/",
     "**/__pycache__",
     "**/_build",
     ".ruff_cache/**",
@@ -116,7 +105,6 @@ extend-include = ["*.ipynb"]
 preview = true
 show-fixes = true
 src = ["src"]
-target-version = "py39"
 
 [tool.ruff.format]
 docstring-code-format = true
@@ -202,6 +190,5 @@ sort_first = [
     "tool.setuptools",
     "tool.setuptools_scm",
 ]
-sort_table_keys = true
 spaces_indent_inline_array = 4
 trailing_comma_inline_array = true

src/jax_benchmark/__init__.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import argparse
 import os
 import socket

src/jax_benchmark/dot_product.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import argparse
 import logging
 import timeit