feat: migrate from pylint/black to ruff (#31)

Linked Epic: overhangio/tutor#1251

- Migrate linting/formatting from **pylint/black** to **ruff**
- Add new rules:
  - `I`: sort imports
  - `N`: enforce PEP8 naming standards
  - `W292`: check for missing newline at EOF
- For config lines exceeding the 88-character limit, add `# noqa: E501` to ignore
- Replace `pylint`/`black` with `ruff` as optional dev dependency

- Add check for Python package distribution build in GitHub CI (`make test`)
- This ensures PyPI publishing won’t fail due to build errors

Author: Abdul-Muqadim-Arbisoft

.hatch_build.py

@@ -16,5 +16,5 @@ def load_about() -> dict[str, str]:
     with open(
         os.path.join(HERE, "tutorjupyter", "__about__.py"), "rt", encoding="utf-8"
     ) as f:
-        exec(f.read(), about)  # pylint: disable=exec-used
+        exec(f.read(), about)
     return about

Makefile

@@ -1,34 +1,42 @@
 .DEFAULT_GOAL := help
 .PHONY: docs
 SRC_DIRS = ./tutorjupyter
-BLACK_OPTS = --exclude templates ${SRC_DIRS}
 
-# Warning: These checks are not necessarily run on every PR.
-test: test-lint test-types test-format  # Run some static checks.
+# Warning: These checks are run on every PR.
+test: test-lint test-format test-types test-pythonpackage # Run some static checks.
 
-test-format: ## Run code formatting tests
-	black --check --diff $(BLACK_OPTS)
+test-format: ## Run code formatting tests.
+	ruff format --check --diff $(SRC_DIRS)
 
 test-lint: ## Run code linting tests
-	pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS}
+	ruff check ${SRC_DIRS}
 
 test-types: ## Run type checks.
 	mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS}
 
-format: ## Format code automatically
-	black $(BLACK_OPTS)
+build-pythonpackage: ## Build the "tutor-jupyter" python package for upload to pypi
+	python -m build --sdist
 
-isort: ##  Sort imports. This target is not mandatory because the output may be incompatible with black formatting. Provided for convenience purposes.
-	isort --skip=templates ${SRC_DIRS}
+test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi
+	twine check dist/tutor_jupyter-$(shell make version).tar.gz
+
+format: ## Format code automatically.
+	ruff format ${SRC_DIRS}
+
+fix-lint: ## Fix lint errors automatically
+	ruff check --fix ${SRC_DIRS}
 
 changelog-entry: ## Create a new changelog entry.
 	scriv create
 
 changelog: ## Collect changelog entries in the CHANGELOG.md file.
 	scriv collect
 
-ESCAPE = 
-help: ## Print this help
+version: ## Print the current tutor-jupyter version
+	@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutorjupyter", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
+
+ESCAPE =
+help: ## Print this help.
 	@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
 		| sed 's/######* \(.*\)/@               $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \
 		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'

changelog.d/20250907_195728_abdul.muqadim_migrate_ruff.md

@@ -0,0 +1,2 @@
+- [Improvement] Migrate from pylint and black to ruff. (by @Abdul-Muqadim-Arbisoft)
+- [Improvement] Test python package distribution build when running make test. (by @Abdul-Muqadim-Arbisoft)

pyproject.toml

@@ -36,8 +36,7 @@ dynamic = ["version"]
 [project.optional-dependencies]
 dev = [
   "tutor[dev]>=20.0.0,<21.0.0",
-  "pylint",
-  "black"
+  "ruff",
 ]
 
 [project.entry-points."tutor.plugin.v1"]
@@ -67,3 +66,19 @@ exclude = ["tests*"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["tutorjupyter"]
+
+[tool.ruff]
+exclude = ["templates", "docs/_ext"]
+
+[tool.ruff.lint]
+# E: pycodestyle errors
+# I: isort
+# N: pep8-naming
+select = ["E", "I", "N"]
+
+# F401: unused-import
+# F841: unused-variable
+# W292: missing-newline-at-end-of-file
+extend-select = ["F401", "F841", "W292"]
+
+[tool.ruff.format]

tutorjupyter/plugin.py

@@ -24,8 +24,8 @@
 config: t.Dict[str, t.Dict[str, t.Any]] = {
     "defaults": {
         "VERSION": __version__,
-        "DOCKER_IMAGE_HUB": "{{ DOCKER_REGISTRY }}overhangio/jupyterhub:{{ JUPYTER_VERSION }}",
-        "DOCKER_IMAGE_LAB": "{{ DOCKER_REGISTRY }}overhangio/jupyterlab:{{ JUPYTER_VERSION }}",
+        "DOCKER_IMAGE_HUB": "{{ DOCKER_REGISTRY }}overhangio/jupyterhub:{{ JUPYTER_VERSION }}",  # noqa: E501
+        "DOCKER_IMAGE_LAB": "{{ DOCKER_REGISTRY }}overhangio/jupyterlab:{{ JUPYTER_VERSION }}",  # noqa: E501
         "HOST": "jupyter.{{ LMS_HOST }}",
         "DEFAULT_PASSPORT_ID": "jupyterhub",
         "LTI_CLIENT_KEY": "openedx",
@@ -52,9 +52,10 @@
 
 def jupyterhub_crypt_key(size: int) -> str:
     """
-    Return a random hex-encoded bytes string of fixed size. This is equivalent to `openssl rand -hex 32`.
+    Return a random hex-encoded bytes string of fixed size.
+    This is equivalent to `openssl rand -hex 32`.
     https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html#authentication-state
-    """
+    """  # noqa: E501
     return codecs.encode(token_bytes(size), "hex").decode()