Merge branch 'main' into pujol-cg-10392-advanced-topics-in-importsexports

Author: kopekC

.github/actions/setup/action.yml

@@ -0,0 +1,20 @@
+name: "Setup"
+description: "Setup tools for run"
+
+runs:
+  using: "composite"
+  steps:
+
+    - name: Install UV
+      uses: astral-sh/setup-uv@v5
+      id: setup-uv
+      with:
+        enable-cache: false
+        prune-cache: true
+        version: '0.5.21'
+        cache-dependency-glob: '**/uv.lock'
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        uv sync --frozen

.github/workflows/pre-commit.yml

@@ -0,0 +1,44 @@
+name: pre-commit
+
+on:
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  pre-commit:
+    # changing the following value will significantly affect github's billing. Be careful and consult with the team before changing it.
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Setup backend
+        id: setup
+        uses: ./.github/actions/setup
+
+      - name: Setup-pre-commit
+        run: uv tool install pre-commit --with pre-commit-uv --force-reinstall
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/pre-commit
+            ~/.cache/uv
+          key: pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('\.pre-commit-config.yaml') }}
+
+      - name: Run pre-commit
+        run: uv run --frozen pre-commit run --show-diff-on-failure --color=always --all-files --source ${{ github.event.pull_request.base.sha }} --origin ${{ github.event.pull_request.head.sha }} --show-diff-on-failure --color=always
+        shell: bash
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        # Always commit changes even if pre-commit failed
+        if: always()
+        with:
+          commit_message: "Automated pre-commit update"

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+default_language_version:
+  python: python3.12
+fail_fast: true
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [python, jupyter, pyi]
+        args: [--fix]
+
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [python, jupyter, pyi]
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.1
+    hooks:
+      - id: nbstripout
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: tests/
+        exclude_types: [mdx, pyi]
+      - id: check-yaml
+      - id: end-of-file-fixer
+        files: .*/expected_diff.patch
+      - id: check-merge-conflict
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.31.0
+    hooks:
+      - id: check-github-workflows
+      - id: check-github-actions
+        args: ["--verbose"]
+
+  - repo: https://github.com/mxr/sync-pre-commit-deps
+    rev: v0.0.3
+    hooks:
+      - id: sync-pre-commit-deps
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.0
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+        files: ".*"
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: "0.5.24"
+    hooks:
+      - id: uv-lock
+        entry: bash -c "uv lock --frozen"

README.md

@@ -15,17 +15,12 @@ brew install uv
 
 Create and activate a Python 3.13 virtual environment
 ```bash
-uv venv --python 3.13.0 && source .venv/bin/activate
+uv venv && source .venv/bin/activate
 ```
 
 Install the `codegen` package
 ```bash
-uv pip install codegen
-```
-
-__Optional__: Install Jupyter for interactive exploration
-```bash
-uv pip install jupyterlab && jupyter lab
+uv sync
 ```
 
 ## Examples