remove hard-coded uid 1000

* build: Add hatch_build in sdist to fix installation issues

.github/workflows/auto-add-to-project.yml

@@ -0,0 +1,20 @@
+name: Auto Add Issues and Pull Requests to Project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  # https://github.com/actions/add-to-project
+  add-to-project:
+    name: Add issue and bugs to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v1.0.2
+        with:
+          project-url: https://github.com/orgs/overhangio/projects/4
+          github-token: ${{ secrets.GH_PROJECT_PERSONAL_ACCESS_TOKEN }}

.github/workflows/sync.yml

@@ -2,13 +2,13 @@ name: Sync with private repo
 
 on:
   push:
-    branches: [ master, main, nightly ]
+    branches: [ release, main ]
 
 jobs:
   sync:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Add remote

.github/workflows/test.yml

@@ -2,19 +2,22 @@ name: Run tests
 
 on:
   pull_request:
-    branches: [master]
+    branches: [ release, main ]
+  push:
+    branches: [ release, main ]
 
 jobs:
   tests:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.12']
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.8
-      - name: Upgrade pip
-        run: python -m pip install --upgrade pip setuptools
+          python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
           pip install .[dev]

.gitlab-ci.yml

@@ -2,7 +2,6 @@ variables:
     TUTOR_PLUGIN: xqueue
     TUTOR_IMAGES: xqueue
     TUTOR_PYPI_PACKAGE: tutor-xqueue
-    OPENEDX_RELEASE: quince
     GITHUB_REPO: overhangio/tutor-xqueue
 
 include:

.hatch_build.py

@@ -0,0 +1,21 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+
+import os
+import typing as t
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+HERE = os.path.dirname(__file__)
+
+
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        about = load_about()
+        metadata["version"] = about["__version__"]
+
+
+def load_about() -> dict[str, str]:
+    about: dict[str, str] = {}
+    with open(os.path.join(HERE, "tutorxqueue", "__about__.py"), "rt", encoding="utf-8") as f:
+        exec(f.read(), about)
+    return about

CHANGELOG.md

@@ -19,6 +19,44 @@ instructions, because git commits are used to generate release notes:
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-20.0.0'></a>
+## v20.0.0 (2025-06-05)
+
+- 💥[Feature] Upgrade to Teak. (by @jfavellar90)
+
+<a id='changelog-19.0.2'></a>
+## v19.0.2 (2025-03-12)
+
+- [Improvement] Add hatch_build.py in sdist target to fix the installation issues (by @dawoudsheraz)
+
+<a id='changelog-19.0.1'></a>
+## v19.0.1 (2025-03-11)
+
+- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @jfavellar90)
+
+<a id='changelog-19.0.0'></a>
+## v19.0.0 (2024-10-24)
+
+- 💥 [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @DawoudSheraz)
+
+- 💥[Improvement] Rename Tutor's two branches (by @DawoudSheraz):
+  * Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
+  * Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
+
+- [Bugfix] Fix legacy warnings during Docker build. (by @regisb)
+
+- 💥[Feature] Update Xqueue Image to use Ubuntu 24.04 as base OS. (by @jfavellar90)
+
+- 💥[Feature] Upgrade to Sumac. (by @jfavellar90)
+
+<a id='changelog-18.0.0'></a>
+## v18.0.0 (2024-05-09)
+
+- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)
+
+- 💥[Feature] Upgrade Python version to 3.12.3. (by @jfavellar90)
+- 💥[Feature] Upgrade to Redwood. (by @jfavellar90)
+
 <a id='changelog-17.0.0'></a>
 ## v17.0.0 (2023-12-09)
 

MANIFEST.in

@@ -1,2 +0,0 @@
-recursive-include tutorxqueue/patches *
-recursive-include tutorxqueue/templates *

Makefile

@@ -1,25 +1,30 @@
 .DEFAULT_GOAL := help
 .PHONY: docs
 SRC_DIRS = ./tutorxqueue
-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.
+test: test-lint test-format test-types test-pythonpackage  # Run some static checks.
 
 test-format: ## Run code formatting tests
-	black --check --diff $(BLACK_OPTS)
+	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-xqueue" 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_xqueue-$(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
@@ -27,6 +32,9 @@ changelog-entry: ## Create a new changelog entry.
 changelog: ## Collect changelog entries in the CHANGELOG.md file.
 	scriv collect
 
+version: ## Print the current tutor-xqueue version
+	@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutorxqueue", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
+
 ESCAPE = 
 help: ## Print this help
 	@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \

README.rst

@@ -19,7 +19,7 @@ You should then run the initialisation scripts. The easiest way to do this is to
 Usage
 -----
 
-In the Open edX studio, edit a course and add a new "Advanced blank problem" ("Problem" → "Advanced" →  "Blank Advanced Problem"). Then, click "Edit" and copy-paste the following in the editor::
+In the Open edX studio, edit a course and add a new "Advanced blank problem" ("Problem" → "Advanced problem types" →  "Blank problem"). Then, copy-paste the following in the Blank problem editor::
 
 
     <problem>
@@ -56,7 +56,7 @@ For a problem that includes a file submission, write instead::
 
 Note that in all cases, the queue name must be "openedx".
 
-Save and publish the created unit. Then, access the unit from the LMS and attempt to answer the problem. The answer is sent to the Xqueue service. If you know how to use the Xqueue API, you can access it at http(s)://xqueue.LMS_HOST (in production) or http://xqueue.local.edly.io (in development). However, the Xqueue API is a bit awkward to use. Tutor provides a simple command-line interface to interact with the Xqueue service.
+Save and publish the created unit. Then, access the unit from the LMS and attempt to answer the problem. The answer is sent to the Xqueue service. If you know how to use the Xqueue API, you can access it at http(s)://xqueue.LMS_HOST (in production) or http://xqueue.local.openedx.io (in development). However, the Xqueue API is a bit awkward to use. Tutor provides a simple command-line interface to interact with the Xqueue service.
 
 Count the number of submissions that need to be graded::
 
@@ -96,7 +96,7 @@ Grade the submission (in this case, mark it as being correct)::
 
 The submission should then appear as correct with the message that you provided on the command line:
 
-.. image:: https://github.com/overhangio/tutor-xqueue/raw/master/screenshots/correctanswer.png
+.. image:: https://github.com/overhangio/tutor-xqueue/raw/release/screenshots/correctanswer.png
   :alt: Correct answer
   :align: center
 
@@ -128,7 +128,7 @@ Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to
 License
 -------
 
-This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-xqueue/blob/master/LICENSE.txt>`_.
+This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-xqueue/blob/release/LICENSE.txt>`_.
 
 Troubleshooting
 ---------------

changelog.d/20250806_163740_abdul.rehman02_migrate_ruff.md

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

pyproject.toml

@@ -1,2 +1,85 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+# https://hatch.pypa.io/latest/config/build/
+
+[project]
+name = "tutor-xqueue"
+description = "A Tutor plugin for Xqueue (external grading system)"
+authors = [
+  { name = "Edly" },
+  { email = "hello@edly.io"},
+]
+maintainers = [
+  { name = "Jhony Avella" },
+  { email = "jhony.avella@edunext.co" },
+]
+license = {text = "AGPL-3.0-only"}
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+  "tutor>=20.0.0,<21.0.0",
+]
+
+# These fields will be set by hatch_build.py
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+    "tutor[dev]>=20.0.0,<21.0.0",
+    "ruff"
+]
+
+# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
+[project.urls]
+Homepage = "https://docs.tutor.edly.io/"
+Documentation = "https://github.com/overhangio/tutor-xqueue#readme"
+Issues = "https://github.com/overhangio/tutor-xqueue/issues"
+Source = "https://github.com/overhangio/tutor-xqueue"
+Changelog = "https://github.com/overhangio/tutor-xqueue/blob/release/CHANGELOG.md"
+Community = "https://discuss.openedx.org/tag/tutor"
+
 [build-system]
-requires = ["setuptools", "wheel"]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# hatch-specific configuration
+[tool.hatch.metadata.hooks.custom]
+path = ".hatch_build.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["tutorxqueue"]
+
+[tool.hatch.build.targets.sdist]
+# Disable strict naming, otherwise twine is not able to detect name/version
+strict-naming = false
+include = [ "/tutorxqueue", ".hatch_build.py"]
+exclude = ["tests*"]
+
+[project.entry-points."tutor.plugin.v1"]
+xqueue = "tutorxqueue.plugin"
+
+[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]

setup.py

@@ -1,53 +0,0 @@
-import io
-import os
-from setuptools import setup, find_packages
-
-here = os.path.abspath(os.path.dirname(__file__))
-
-with io.open(os.path.join(here, "README.rst"), "rt", encoding="utf8") as f:
-    readme = f.read()
-
-about = {}
-with io.open(
-    os.path.join(here, "tutorxqueue", "__about__.py"), "rt", encoding="utf-8"
-) as f:
-    exec(f.read(), about)
-
-setup(
-    name="tutor-xqueue",
-    version=about["__version__"],
-    url="https://docs.tutor.edly.io/",
-    project_urls={
-        "Documentation": "https://docs.tutor.edly.io/",
-        "Code": "https://github.com/overhangio/tutor-xqueue",
-        "Issue tracker": "https://github.com/overhangio/tutor-xqueue/issues",
-        "Community": "https://discuss.openedx.org",
-    },
-    license="AGPLv3",
-    author="Overhang.IO",
-    author_email="contact@overhang.io",
-    maintainer="eduNEXT",
-    description="A Tutor plugin for Xqueue (external grading system)",
-    long_description=readme,
-    long_description_content_type="text/x-rst",
-    packages=find_packages(exclude=["tests*"]),
-    include_package_data=True,
-    python_requires=">=3.8",
-    install_requires=["tutor>=17.0.0,<18.0.0", "requests"],
-    extras_require={
-        "dev": ["tutor[dev]>=17.0.0,<18.0.0"],
-    },
-    entry_points={"tutor.plugin.v1": ["xqueue = tutorxqueue.plugin"]},
-    classifiers=[
-        "Development Status :: 5 - Production/Stable",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: GNU Affero General Public License v3",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-    ],
-)

tutorxqueue/__about__.py

@@ -1 +1 @@
-__version__ = "17.0.0"
+__version__ = "20.0.0"

tutorxqueue/patches/local-docker-compose-permissions-command

@@ -1 +1 @@
-setowner 1000 /mounts/xqueue
+setowner {{ APP_USER_ID }} /mounts/xqueue

tutorxqueue/plugin.py

@@ -6,17 +6,16 @@ from glob import glob
 from typing import Any, Literal, Optional, Union
 
 import click
-import pkg_resources
+import importlib_resources
 import requests  # type: ignore
 from tutor import config as tutor_config
-from tutor.__about__ import __version_suffix__
 from tutor import exceptions
 from tutor import hooks as tutor_hooks
 from tutor.__about__ import __version_suffix__
 
 from .__about__ import __version__
 
-# Handle version suffix in nightly mode, just like tutor core
+# Handle version suffix in main mode, just like tutor core
 if __version_suffix__:
     __version__ += "-" + __version_suffix__
 
@@ -24,7 +23,7 @@ config: dict[str, dict[str, Any]] = {
     "defaults": {
         "VERSION": __version__,
         "AUTH_USERNAME": "lms",
-        "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-xqueue:{{ XQUEUE_VERSION }}",
+        "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-xqueue:{{ XQUEUE_VERSION }}",  # noqa: E501
         "HOST": "xqueue.{{ LMS_HOST }}",
         "MYSQL_DATABASE": "xqueue",
         "MYSQL_USERNAME": "xqueue",
@@ -39,22 +38,17 @@ config: dict[str, dict[str, Any]] = {
 }
 
 # Initialization hooks
-
-# To add a custom initialization task, create a bash script template under:
-# tutorxqueue/templates/xqueue/tasks/
-# and then add it to the MY_INIT_TASKS list. Each task is in the format:
-# ("<service>", ("<path>", "<to>", "<script>", "<template>"))
-MY_INIT_TASKS: list[tuple[str, tuple[str, ...]]] = [
-    ("mysql", ("xqueue", "tasks", "mysql", "init")),
-    ("xqueue", ("xqueue", "tasks", "xqueue", "init")),
-]
-
-# For each task added to MY_INIT_TASKS, we load the task template
+# For each service that needs to be initialized, we load the task template
 # and add it to the CLI_DO_INIT_TASKS filter, which tells Tutor to
 # run it as part of the `init` job.
-for service, template_path in MY_INIT_TASKS:
-    full_path: str = pkg_resources.resource_filename(
-        "tutorxqueue", os.path.join("templates", *template_path)
+for service in ["mysql", "xqueue"]:
+    full_path: str = str(
+        importlib_resources.files("tutorxqueue")
+        / "templates"
+        / "xqueue"
+        / "tasks"
+        / service
+        / "init"
     )
     with open(full_path, encoding="utf-8") as init_task_file:
         init_task: str = init_task_file.read()
@@ -152,21 +146,19 @@ def grade_submission(
     print_result(
         context,
         "grade_submission",
-        (
-            submission_id,
-            submission_key,
-            grade,
-            correct,
-            message,
-        ),
+        submission_id,
+        submission_key,
+        grade,
+        correct,
+        message,
     )
 
 
 def print_result(
     context: click.Context,
     client_func_name: str,
-    *args: tuple[Any, ...],
-    **kwargs: dict[str, Any],
+    *args: Any,
+    **kwargs: Any,
 ) -> None:
     user_config = tutor_config.load(context.root)  # type: ignore
     client = Client(user_config, url=context.url)  # type: ignore
@@ -185,7 +177,7 @@ class Client:
         if not self.base_url:
             scheme = "https" if user_config["ENABLE_HTTPS"] else "http"
             host = user_config["XQUEUE_HOST"]
-            self.base_url = "{}://{}".format(scheme, host)
+            self.base_url = f"{scheme}://{host}"
         self.login()
 
     @property
@@ -208,9 +200,7 @@ class Client:
         message = response.get("content")
         if message != "Logged in":
             raise exceptions.TutorError(
-                "Could not login to xqueue server at {}. Response: '{}'".format(
-                    self.base_url, message
-                )
+                f"Could not login to xqueue server at {self.base_url}. Response: '{message}'"  # noqa: E501
             )
 
     def show_submission(self, queue: str) -> Union[dict[str, Any], Any]:
@@ -280,7 +270,7 @@ command.add_command(submissions)
 
 # Add the "templates" folder as a template root
 tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    pkg_resources.resource_filename("tutorxqueue", "templates")
+    str(importlib_resources.files("tutorxqueue") / "templates")
 )
 # Render the "build" and "apps" folders
 tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@@ -290,12 +280,7 @@ tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
     ],
 )
 # Load patches from files
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("tutorxqueue", "patches"),
-        "*",
-    )
-):
+for path in glob(str(importlib_resources.files("tutorxqueue") / "patches" / "*")):
     with open(path, encoding="utf-8") as patch_file:
         tutor_hooks.Filters.ENV_PATCHES.add_item(
             (os.path.basename(path), patch_file.read())

tutorxqueue/templates/xqueue/build/xqueue/Dockerfile

@@ -1,8 +1,11 @@
-# syntax=docker/dockerfile:1.4
-###### Minimal image with base system requirements for most stages ######
-FROM docker.io/ubuntu:20.04 as minimal
+# syntax=docker/dockerfile:1
+FROM docker.io/ubuntu:24.04
 
 ARG DEBIAN_FRONTEND=noninteractive
+
+# Delete default UID=1000 `ubuntu` user to ensure we can use id 1000 for app user
+RUN userdel -r ubuntu
+
 RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
     --mount=type=cache,target=/var/lib/apt,sharing=locked \
     apt update && \
@@ -18,30 +21,31 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
 RUN ln -s /usr/bin/python3 /usr/bin/python
 
 ###### Git-clone xqueue repo ######
-ARG APP_USER_ID=1000
+ARG APP_USER_ID={{ HOST_USER_ID }}
 RUN useradd --home-dir /openedx --create-home --shell /bin/bash --uid ${APP_USER_ID} app
 USER ${APP_USER_ID}
+
 RUN git clone {{ XQUEUE_REPOSITORY }} --branch {{ XQUEUE_REPOSITORY_VERSION }} --depth 1 /openedx/xqueue
 WORKDIR /openedx/xqueue
 
 ###### Install python venv ######
 RUN python -m venv /openedx/venv
-ENV PATH /openedx/venv/bin:${PATH}
+ENV PATH=/openedx/venv/bin:${PATH}
 # https://pypi.org/project/setuptools/
 # https://pypi.org/project/pip/
 # https://pypi.org/project/wheel/
-RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install setuptools==68.2.2 pip==23.2.1. wheel==0.41.2
+RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install setuptools==78.1.0 pip==25.0.1 wheel==0.46.0
 RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install -r requirements.txt
-RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install uwsgi==2.0.22
+RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install uwsgi==2.0.28
 
 RUN mkdir /openedx/data /openedx/data/media
 
 EXPOSE 8000
-CMD uwsgi \
-    --static-map /media=/openedx/data/media/ \
-    --http 0.0.0.0:8000 \
-    --thunder-lock \
-    --single-interpreter \
-    --enable-threads \
-    --processes=2 \
-    --wsgi-file xqueue/wsgi.py
+CMD ["uwsgi", \
+    "--static-map", "/media=/openedx/data/media/", \
+    "--http", "0.0.0.0:8000", \
+    "--thunder-lock", \
+    "--single-interpreter", \
+    "--enable-threads", \
+    "--processes=2", \
+    "--wsgi-file", "xqueue/wsgi.py"]