sync template

ulab-uiuc · May 9, 2024 · 0aa02bc · 0aa02bc
1 parent 832c5ae
commit 0aa02bc
Show file tree

Hide file tree

Showing 9 changed files with 170 additions and 44 deletions.
diff --git a/.github/ISSUE_TEMPLATE/codebase_reorg.yml b/.github/ISSUE_TEMPLATE/codebase_reorg.yml
@@ -0,0 +1,24 @@
+name: 🧹Codebase Reorg
+description: Reorg, clean, format the codebase
+title: "[WRT]: "
+labels: ["writing"]
+assignees: [""]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please make sure this codebase reorg request hasn't been already submitted by someone by looking through other open/closed issues
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Give us a brief description of the codebase reorg task you would like
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional Information
+      description: Give us some additional reason on why codebase reorg is necessary to do
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,31 @@
+name: codespell
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install codespell==2.2.6 tomli==2.0.1
+    - name: Spelling check with codespell
+      run: |
+        codespell --toml pyproject.toml
diff --git a/.github/workflows/isort.yml b/.github/workflows/isort.yml
@@ -0,0 +1,31 @@
+name: isort
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  isort:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install isort==5.13.2
+    - name: Run isort
+      run: |
+        isort . --check-only
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -1,18 +1,28 @@
 name: Mypy
-on: [push]
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   Static-Type-Checking:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 5
+      matrix:
+        python-version: ["3.9", "3.10"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.11.2
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         curl -sSL https://install.python-poetry.org | python3
@@ -21,4 +31,4 @@ jobs:
       run: |
         # Run this mypy instance against our main package.
         poetry run pip install types-protobuf==4.24.0.4
-        poetry run mypy --strict .
+        poetry run mypy --config-file pyproject.toml .
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -8,9 +8,13 @@ on:
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
+
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.11.2
+        python-version: ${{ matrix.python-version }}
diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml
@@ -0,0 +1,31 @@
+name: ruff
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff==0.1.5
+    - name: Analysing the code with ruff
+      run: |
+        ruff check .
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,18 +1,23 @@
 name: Pytest
-on: [push]
+on:
+  pull_request:
+  push:
+    branches: [main]
 
 jobs:
   Pytest:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 5
+      matrix:
+        python-version: ["3.9", "3.10"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.11.2
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         curl -sSL https://install.python-poetry.org | python3

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,17 +1,4 @@
 repos:
-- repo: local
-  hooks:
-    - id: poetry-update
-      name: Poetry Update
-      entry: poetry update
-      language: system
-      # Optional: specify types or files to trigger this hook
-      # files: pyproject.toml
-      # Always run this hook (not recommended for update; shown for illustrative purposes):
-      always_run: true
-      # Optional: prevent commit if the lock file changes
-      stages: [pre-commit]
-      pass_filenames: false
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v3.2.0
     hooks:
@@ -24,16 +11,17 @@ repos:
     hooks:
     -   id: prettier
         types_or: [html]
--   repo: https://github.com/psf/black
-    rev: 22.12.0
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.5
     hooks:
-    -   id: black
-        args: [--line-length=79]
--   repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-    -   id: isort
-        args: ["--profile", "black", --line-length=72]
+    # Run the linter.
+    -   id: ruff
+        types_or: [ python, pyi, jupyter ]
+        args: [ --fix ]
+    # Run the formatter.
+    -   id: ruff-format
+        types_or: [ python, pyi, jupyter ]
 -   repo: https://github.com/kynan/nbstripout
     rev: 0.6.0
     hooks:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "research-town"
+name = "python-project-template"
 version = "0.0.1"
-description = "A multi-agent framework for research pipeline."
+description = "A template for python-based research project"
 authors = ["Haofei Yu <[email protected]>"]
 license = "Apache 2.0 License"
 readme = "README.md"
@@ -38,11 +38,13 @@ plugins = [
     "pydantic.mypy"
 ]
 
-[[tool.mypy.overrides]]
-module = "transformers.*"
-ignore_missing_imports = true
-
-
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "test_*.py"
+
+[tool.codespell]
+ignore-words-list = "dout, te, indicies, astroid"
+
+[tool.isort]
+use_parentheses = true
+skip_gitignore = true