build: move to a uv based project management setup

Author: MoisesGSalas

Makefile

@@ -1,56 +1,24 @@
-.PHONY: quality  help requirements\
-	piptools selfcheck  upgrade test clean
-
 .DEFAULT_GOAL := help
+.PHONY: help
 
-piptools: ## install pinned version of pip-compile and pip-sync
-	pip install -r requirements/pip-tools.txt
-
-help: ## display this help message
-	@echo "Please use \`make <target>' where <target> is one of"
-	@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
-
-# Define PIP_COMPILE_OPTS=-v to get more information during make upgrade.
-PIP_COMPILE = pip-compile --upgrade $(PIP_COMPILE_OPTS)
-
-clean: ## remove generated byte code, coverage reports, and build artifacts
-	find tutorcodejail -name '__pycache__' -exec rm -rf {} +
-	find tutorcodejail -name '*.pyc' -exec rm -f {} +
-	find tutorcodejail -name '*.pyo' -exec rm -f {} +
-	find tutorcodejail -name '*~' -exec rm -f {} +
-	coverage erase
-	rm -fr build/
-	rm -fr dist/
-	rm -fr *.egg-info
-
+quality: ## Run linters
+	uv run ruff check
+	uv run ruff format --diff
+	uv run ty   check
 
-upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
-	make piptools
-	# Make sure to compile files after any other files they include!
-	$(PIP_COMPILE) --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
-	$(PIP_COMPILE) -o requirements/pip-tools.txt requirements/pip-tools.in
-	make piptools
-	$(PIP_COMPILE) -o requirements/base.txt requirements/base.in
-	$(PIP_COMPILE) -o requirements/dev.txt requirements/dev.in
+quality-fix: ## Run automatic linter fixes
+	uv run ruff format
+	uv run ruff check --fix
 
-quality: ## check coding style with pycodestyle and pylint
-	pylint tutorcodejail *.py
-	isort --check-only --diff --recursive tutorcodejail *.py
-	python setup.py bdist_wheel
-	twine check dist/*
-	make selfcheck
+changelog-entry: ## Run scriv to create a changelog entry
+	uv run scriv create
 
-requirements: ## install development environment requirements
-	pip install -r requirements/pip.txt
-	pip install -r requirements/pip-tools.txt
-	pip-sync requirements/dev.txt
-	pip install -e .
+changelog-collect: ## Collect all the changelog entries and rebuild CHANGELOG.md
+	uv run scriv collect
 
-test: ## run unitary tests and meassure coverage
-	coverage run -m pytest
-	coverage report -m --fail-under=62
-	@echo "Testing module buiding..."
+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}'
 
-selfcheck: ## check that the Makefile is well-formed
-	@echo "The Makefile is well-formed."

pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "tutor-contrib-codejail"
+version = "21.0.0"
+description = "Codejail plugin for Tutor"
+readme = "README.rst"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [
+    { name = "eduNEXT" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "tutor~=21.0"
+]
+[project.urls]
+Homepage = "https://github.com/edunext/tutor-contrib-codejail"
+Code = "https://github.com/edunext/tutor-contrib-codejail"
+"Issue tracker" = "https://github.com/edunext/tutor-contrib-codejail/issues"
+
+[project.entry-points."tutor.plugin.v1"]
+codejail = "tutorcodejail.plugin"
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+lint.select = [
+    "E4",
+    "E7",
+    "E9",
+    "F",
+    "I",
+    "UP",
+]
+extend-exclude = ["tutorcodejail/patches", "tutorcodejail/templates"]
+
+[tool.ty.src]
+exclude = ["tutorcodejail/patches", "tutorcodejail/templates"]
+
+[tool.scriv]
+version = "literal: pyproject.toml: project.version"
+categories = "Added, Changed, Fixed, Removed"
+format = "md"
+md_header_level = 2
+new_fragment_template = "file: changelog.d/scriv/new_fragment.md.j2"
+entry_title_template = "file: changelog.d/scriv/entry_title.md.j2"
+
+[build-system]
+requires = ["uv_build>=0.9.5,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.15.0",
+    "scriv>=1.8.0",
+    "ty>=0.0.16",
+]
+
+[tool.uv.build-backend]
+module-root = "."
+module-name = "tutorcodejail"
+

setup.cfg

@@ -1,2 +1,3 @@
 """Helps you keep your cool when creating dozens of open edX and eduNEXT environments."""
+
 __version__ = "21.0.0"

setup.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-import typing as t
 from glob import glob
 from pathlib import Path
 
@@ -75,7 +74,7 @@ def get_apparmor_abi():
 
 @hooks.Filters.IMAGES_BUILD.add()
 def _build_codejail_images(
-    images: list[tuple[str, t.Union[str, tuple[str, ...]], str, tuple[str, ...]]],
+    images: list[tuple[str, str | tuple[str, ...], str, tuple[str, ...]]],
     tutor_config: Config,
 ):
     """Choose the appropiate build context when using CODEJAIL_USE_SERVICE_V2."""
@@ -106,7 +105,7 @@ def _build_codejail_images(
 
 @hooks.Filters.IMAGES_PUSH.add()
 def _push_codejail_images(
-    images: list[tuple[str, t.Union[str, tuple[str, ...]], str, tuple[str, ...]]],
+    images: list[tuple[str, str | tuple[str, ...], str, tuple[str, ...]]],
     tutor_config: Config,
 ):
     """Choose the appropiate image tag when using CODEJAIL_USE_SERVICE_V2."""
@@ -130,9 +129,7 @@ def _push_codejail_images(
 
 # Boilerplate code
 # Add the "templates" folder as a template root
-hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    str(importlib_resources.files("tutorcodejail") / "templates")
-)
+hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(str(importlib_resources.files("tutorcodejail") / "templates"))
 # Render the "build" and "apps" folders
 hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
     [
@@ -149,7 +146,5 @@ def _push_codejail_images(
 hooks.Filters.CONFIG_DEFAULTS.add_items(
     [(f"CODEJAIL_{key}", value) for key, value in config.get("defaults", {}).items()]
 )
-hooks.Filters.CONFIG_UNIQUE.add_items(
-    [(f"CODEJAIL_{key}", value) for key, value in config.get("unique", {}).items()]
-)
+hooks.Filters.CONFIG_UNIQUE.add_items([(f"CODEJAIL_{key}", value) for key, value in config.get("unique", {}).items()])
 hooks.Filters.CONFIG_OVERRIDES.add_items(list(config.get("overrides", {}).items()))