Merge branch 'release/0.2.2'

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-case-conflict
       - id: check-added-large-files
@@ -19,17 +19,21 @@ repos:
       - id: check-docstring-first
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.275
+    rev: v0.3.2
     hooks:
       - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [ --fix ]
+      - id: ruff-format
+        types_or: [ python, pyi, jupyter ]
 
   - repo: https://github.com/kynan/nbstripout
-    rev: "0.6.1"
+    rev: "0.7.1"
     hooks:
       - id: nbstripout
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: "0.23.2"
+    rev: "0.28.0"
     hooks:
       - id: check-github-workflows
       - id: check-readthedocs

.ruff.toml

@@ -3,10 +3,14 @@ extend-exclude = ["docs"]
 # Always generate Python 3.7-compatible code.
 target-version = "py37"
 line-length = 128
+
+[lint]
 ignore-init-module-imports = true
-[mccabe]
+
+[lint.mccabe]
 # Unlike Flake8, default to a complexity level of 10.
 max-complexity = 10
+
+[lint.per-file-ignores]
 # Ignore `F401`(imported but unused), `F403`(import *` used), `E402`(import violations) in all `__init__.py` files
-[per-file-ignores]
 "__init__.py" = ["E402", "F401", "F403"]

CHANGELOG.md

@@ -1,4 +1,10 @@
-# Changelog
+# CHANGELOG
+
+## v0.2.2
+
+> 📅 **Date** 2024-3-11
+
+Update dependencies and tools to latest version.
 
 ## v0.2.1
 

README.md

@@ -17,7 +17,7 @@ The project itself's documentation site is a demo of how to use it.
 To build and serve the doc-site:
 
 ```bash
-pip install -r dev.requirements.txt
+pip install -r requirements.txt
 mkdocs serve
 ```
 

notebooks/image.ipynb

@@ -33,9 +33,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "base_url = 'https://www.bing.com'\n",
-    "img_url = requests.get(f'{base_url}/HPImageArchive.aspx?format=js&idx=0&n=1').json()['images'][0]['url']\n",
-    "img_full_url = f'{base_url}{img_url}'\n",
+    "base_url = \"https://www.bing.com\"\n",
+    "img_url = requests.get(f\"{base_url}/HPImageArchive.aspx?format=js&idx=0&n=1\").json()[\"images\"][0][\"url\"]\n",
+    "img_full_url = f\"{base_url}{img_url}\"\n",
     "print(img_full_url)\n",
     "display(Image(url=img_full_url, width=320, height=240))"
    ]
@@ -54,7 +54,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "display(Image(filename='../static/img_01.jpeg'))"
+    "display(Image(filename=\"../static/img_01.jpeg\"))"
    ]
   }
  ],

notebooks/matplotlib.ipynb

@@ -34,12 +34,12 @@
    "source": [
     "x = np.linspace(0, 2, 100)\n",
     "\n",
-    "plt.plot(x, x, label='linear')\n",
-    "plt.plot(x, x**2, label='quadratic')\n",
-    "plt.plot(x, x**3, label='cubic')\n",
+    "plt.plot(x, x, label=\"linear\")\n",
+    "plt.plot(x, x**2, label=\"quadratic\")\n",
+    "plt.plot(x, x**3, label=\"cubic\")\n",
     "\n",
-    "plt.xlabel('x label')\n",
-    "plt.ylabel('y label')\n",
+    "plt.xlabel(\"x label\")\n",
+    "plt.ylabel(\"y label\")\n",
     "\n",
     "plt.title(\"Simple Plot\")\n",
     "\n",

dev.requirements.txt → requirements.txt

@@ -18,5 +18,6 @@ requests
 
 # CI tools
 build
+setuptools_scm
 pre-commit
 ruff

src/mkdocs_nbconvert/plugin.py

@@ -11,8 +11,10 @@
 from mkdocs.structure.files import File
 from mkdocs.utils import log
 from nbconvert import MarkdownExporter
-from nbconvert.preprocessors import CellExecutionError, ExecutePreprocessor  # pyright: ignore[reportPrivateImportUsage]
-
+from nbconvert.preprocessors import (  # pyright: ignore[reportPrivateImportUsage]
+    CellExecutionError,
+    ExecutePreprocessor,
+)
 
 __all__ = ["NbConvertPlugin"]