[WIP] nim anywhere next

.github/workflows/ci.yml

@@ -14,42 +14,32 @@ permissions:
 
 jobs:
   ci:
-
     runs-on: ubuntu-latest
+
     strategy:
       matrix:
         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 }}
+        cache: "pip"
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        grep -vf req.filters.txt requirements.txt | pip install -r /dev/stdin
-        ./code/tools/lint.sh deps
-
-    - name: Check Python syntax with Pylint
-      run: |
-        ./code/tools/lint.sh pylint
-
-    - name: Check Type Hints with MyPy
-      run: |
-        ./code/tools/lint.sh mypy
-
-    - name: Check code formatting with Black
-      run: |
-        ./code/tools/lint.sh black
-
-    - name: Ensure Notebooks have no output
-      run: |
-        ./code/tools/lint.sh ipynb
-
-
-
-
-
+        python -m pip install --upgrade pip wheel
+        pip install -r requirements.txt
+        pip install ruff mypy
+
+    - name: Check code formatting
+      run: make format
+    - name: Run code linters
+      run:  make lint
+    - name: Check typehints
+      run: make typecheck
+    - name: Ensure notebooks have no output
+      run: make check-notebooks

.gitignore

@@ -1,5 +1,6 @@
 # Ignore generated or temporary files managed by the Workbench
 .project/*
+!.project/compose.yaml
 !.project/spec.yaml
 !.project/configpacks
 
@@ -56,6 +57,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+.ruff_cache
 
 # Workbench Project Layout
 data/scratch/*

.project/spec.yaml

@@ -13,7 +13,7 @@ layout:
     - path: code/
       type: code
       storage: git
-    - path: docs/
+    - path: libs/
       type: code
       storage: git
     - path: data/
@@ -25,8 +25,8 @@ layout:
 environment:
     base:
         registry: nvcr.io
-        image: nvidia/ai-workbench/python-cuda122:1.0.3
-        build_timestamp: "20231214221614"
+        image: nvidia/ai-workbench/python-cuda122:1.0.6
+        build_timestamp: "20250205043304"
         name: Python with CUDA 12.2
         supported_architectures: []
         cuda_version: "12.2"
@@ -53,8 +53,8 @@ environment:
                 url_command: jupyter lab list | head -n 2 | tail -n 1 | cut -f1 -d' ' | grep -v 'Currently'
         programming_languages:
             - python3
-        icon_url: ""
-        image_version: 1.0.3
+        icon_url: https://workbench.download.nvidia.com/static/img/ai-workbench-icon-rectangle.jpg
+        image_version: 1.0.6
         os: linux
         os_distro: ubuntu
         os_distro_release: "22.04"
@@ -75,17 +75,14 @@ environment:
                 - python3-dev
                 - python3-pip
                 - vim
-                - less
-                - jq
-                - ssh
             - name: pip
-              binary_path: /usr/local/bin/pip
+              binary_path: /usr/bin/pip
               installed_packages:
-                - jupyterlab==4.0.7
+                - jupyterlab==4.2.5
         package_manager_environment:
             name: ""
             target: ""
-    compose_file_path: ""
+    compose_file_path: .project/compose.yaml
 execution:
     apps:
         - name: Visual Studio Code

.vscode/extensions.json

@@ -2,11 +2,8 @@
     "recommendations": [
         "ms-python.vscode-pylance",
         "ms-python.python",
-        "ms-python.debugpy",
         "ms-python.mypy-type-checker",
-        "ms-python.black-formatter",
-        "ms-python.isort",
-        "ms-python.pylint",
-        "ms-toolsai.jupyter"
+        "ms-toolsai.jupyter",
+        "charliermarsh.ruff"
     ]
 }

.vscode/settings.json

@@ -1,37 +1,33 @@
 {
   // file explorer configuration
   "files.exclude": {
-    "**/.git": true,
-    "**/.svn": true,
-    "**/.hg": true,
+    ".git": true,
     "**/CVS": true,
     "**/.DS_Store": true,
     "**/Thumbs.db": true,
     "**/.venv": true,
     "**/__pycache__": true,
     "**/.mypy_cache": true,
     "**/.ipynb_checkpoints": true,
-    "**/.terraform": true,
+    ".project": true,
+    ".vscode": true,
+    ".github": true,
+    "**/.ruff_cache": true,
   },
 
-
   // global editor settings
   "files.eol": "\n",
   "editor.tabSize": 4,
   "editor.insertSpaces": true,
   "files.insertFinalNewline": true,
-  // remove this line to automatically forward ports
-  // in general, workbench will manage this already
   "remote.autoForwardPorts": false,
 
-
   // bash scripting configuration
   "[shellscript]": {
     "editor.tabSize": 4,
-    "editor.insertSpaces": false,
+    "editor.insertSpaces": false
   },
 
-
   // css style sheet configuration
   "[css]": {
     "editor.suggest.insertMode": "replace",
@@ -41,31 +37,29 @@
   // js configuration
   "[javascript]": {
     "editor.maxTokenizationLineLength": 2500,
-    "editor.tabSize": 2,
+    "editor.tabSize": 2
   },
 
   // Python environment configuration
   "python.terminal.activateEnvironment": true,
   "python.defaultInterpreterPath": "/usr/bin/python3",
-  "isort.args":["--profile", "black"],
-  "isort.check": true,
+
+  // Ruff as formatter
   "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": "explicit"
+      "source.organizeImports": "explicit",
+      "source.fixAll": "explicit"
     },
-    //  Comment out this settings to disable auto-formatting
     "editor.formatOnSave": true
   },
 
-  "black-formatter.serverTransport": "stdio",
-  "black-formatter.args": [
-    "--line-length",
-    "120"
+  "ruff.enable": true,
+  "ruff.exclude": [],
+  // tutorial apps use a different python environment
+  "python.analysis.exclude": [
+    "code/tutorial_app/**",
+    "libs/**"
   ],
-  "pylint.severity": {
-    "refactor": "Information",
-  },
-
-  "python.analysis.ignore": ["code/tutorial_app/**"]
+  "mypy-type-checker.ignorePatterns": ["**/answers/*"],
 }

Makefile

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+## Help command
+default: help
+.PHONY: help
+help: # Show help for each of the Makefile recipes.
+	@echo "Available targets:"
+	@grep -E '^[a-zA-Z0-9 -]+:.*#'  Makefile | sort | while read -r l; do printf "\033[1;32m$$(echo $$l | cut -f 1 -d':')\033[00m:$$(echo $$l | cut -f 2- -d'#')\n"; done
+
+## CI Pipeline logic
+.PHONY: ci lint format typecheck test check-notebooks
+ci: lint format typecheck check-notebooks test # Run the ci pipeline locally
+
+lint: # Examing the code with linters
+	ruff check .
+
+format: # Check the code formatting
+	ruff format --check .
+
+format-fix: # Autofix the code formatting where it is possible
+
+typecheck: # Check the type hints in the code
+	mypy .
+
+test: # Run unit tests
+	# pytest --quiet
+
+check-notebooks:  # Ensure the jupyter notebooks have no saved
+	find . -name "*.ipynb" -exec jupyter nbconvert --clear-output --inplace {} +
+	git diff --exit-code || (echo "Notebooks have output. Clear it before committing." && exit 1)