e2xauthoring 0.1.0__tar.gz → 0.2.0.dev0__tar.gz

{e2xauthoring-0.1.0 → e2xauthoring-0.2.0.dev0}/.pre-commit-config.yaml

@@ -1,20 +1,26 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 23.1.0
     hooks:
       - id: black
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.11.5
     hooks:
       - id: isort
         files: \.py$
         args: [--profile=black]
 
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.267"
+    hooks:
+      - id: ruff
+
   - repo: local
     hooks:
       - id: prettier
         name: prettier
         entry: 'npm run prettier:files'
         language: node
-        types_or: [json, markdown, ts, tsx, javascript, jsx, css]
+        types_or: [json, markdown, ts, tsx, javascript, jsx, css]
+        exclude_types: [jupyter]

{e2xauthoring-0.1.0 → e2xauthoring-0.2.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: e2xauthoring
-Version: 0.1.0
+Version: 0.2.0.dev0
 Summary: Authoring app for e2xgrader
 Project-URL: Source, https://github.com/Digiklausur/e2xauthoring
 Author-email: Tim Metzler <tim.metzler@h-brs.de>
@@ -12,15 +12,16 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Requires-Python: >=3.7
-Requires-Dist: e2xgrader==0.1.*
+Requires-Dist: e2xcore==0.0.2
 Requires-Dist: gitpython
 Provides-Extra: dev
 Requires-Dist: hatchling; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: tbump; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # e2xauthoring
 
 ---
 
-This is an authoring component for e2xgrader
+This is an authoring component for e2xgrader

e2xauthoring-0.2.0.dev0/README.md

@@ -0,0 +1,5 @@
+# e2xauthoring
+
+---
+
+This is an authoring component for e2xgrader

e2xauthoring-0.2.0.dev0/e2xauthoring/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0-dev0"

{e2xauthoring-0.1.0 → e2xauthoring-0.2.0.dev0}/e2xauthoring/app/authoring.py

@@ -1,15 +1,14 @@
 import os
 
-from e2xgrader.server_extensions.grader.apps.base import BaseApp
+from e2xcore import BaseApp
 from nbgrader.apps.baseapp import NbGrader
 from tornado import web
 
-from .apihandlers import default_handlers
-from .handlers import default_handlers as handlers
+from .handlers.apihandlers import default_handlers
+from .handlers.handlers import default_handlers as handlers
 
 
 class AuthoringApp(NbGrader, BaseApp):
-
     template_path = os.path.join(os.path.dirname(__file__), "templates")
     static_path = os.path.join(template_path, "authoring", "static")
 

{e2xauthoring-0.1.0/e2xauthoring/app → e2xauthoring-0.2.0.dev0/e2xauthoring/app/handlers}/apihandlers.py

@@ -1,27 +1,71 @@
 import json
+import os
 
-from e2xgrader.converters import GenerateExercise
-from e2xgrader.models import AssignmentModel, TemplateModel
-from e2xgrader.server_extensions.grader.apps.authoring.apihandlers import (
-    BaseApiListHandler,
-    BaseApiManageHandler,
-    E2xApiHandler,
-    ExerciseModel,
-    KernelSpecHandler,
-    PresetHandler,
-    TemplateVariableHandler,
-    api_url,
-    assignment_regex,
-    name_regex,
-    pool_regex,
-)
-from e2xgrader.utils import urljoin
+from e2xcore.handlers import E2xApiHandler
+from e2xcore.utils import urljoin
+from jupyter_client.kernelspec import KernelSpecManager
 from nbgrader.server_extensions.formgrader.base import check_xsrf
 from tornado import web
 
-from e2xauthoring.utils import get_author, set_author
+from ...converters import GenerateExercise
+from ...models import (
+    AssignmentModel,
+    ExerciseModel,
+    PresetModel,
+    TaskModel,
+    TaskPoolModel,
+    TemplateModel,
+)
+from ...utils import NotebookVariableExtractor
+from ...utils.gitutils import get_author, set_author
+from .base import BaseApiListHandler, BaseApiManageHandler
+
+
+class PresetHandler(E2xApiHandler):
+    def initialize(self):
+        self.__model = PresetModel(self.coursedir)
+
+    def _list_template(self):
+        self.write(json.dumps(self.__model.list_template_presets()))
+
+    def _get_template(self):
+        name = self.get_argument("name")
+        self.write(json.dumps(self.__model.get_template_preset(name)))
+
+    def _list_question(self):
+        self.write(json.dumps(self.__model.list_question_presets()))
+
+    def _get_question(self):
+        name = self.get_argument("name")
+        self.write(json.dumps(self.__model.get_question_preset(name)))
+
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        action = self.get_argument("action")
+        preset_type = self.get_argument("type")
+        handler = getattr(self, "_{}_{}".format(action, preset_type))
+        handler()
+
+
+class TemplateVariableHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        template = self.get_argument("template")
+        variables = NotebookVariableExtractor().extract(
+            os.path.join(
+                self.url_prefix, "templates", template, "{}.ipynb".format(template)
+            )
+        )
+        self.write(json.dumps(variables))
+
 
-from ..models import TaskModel, TaskPoolModel
+class KernelSpecHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        self.write(json.dumps(KernelSpecManager().get_all_specs()))
 
 
 class ManagePoolsHandler(E2xApiHandler):
@@ -185,6 +229,9 @@ class GitAuthorHandler(E2xApiHandler):
         self.write(json.dumps(set_author(name=name, email=email)))
 
 
+api_url = urljoin("e2x", "authoring", "api")
+name_regex = r"(?P<name>[^/]+)"
+assignment_regex = r"(?P<assignment>[^/]+)"
 pool_action_regex = r"(?P<action>new|list|remove|get|init_repo)"
 task_action_regex = r"(?P<action>new|list|list_all|remove|commit|get|diff)"
 template_action_regex = r"(?P<action>new|list|remove)"

e2xauthoring-0.2.0.dev0/e2xauthoring/app/handlers/base.py

@@ -0,0 +1,41 @@
+import json
+
+from e2xcore.handlers import E2xApiHandler
+from nbgrader.server_extensions.formgrader.base import check_xsrf
+from tornado import web
+
+
+class BaseApiManageHandler(E2xApiHandler):
+    def initialize(self, model_cls):
+        self.__model = model_cls(self.coursedir)
+
+    @web.authenticated
+    @check_xsrf
+    def post(self, **kwargs):
+        self.write(self.__model.new(**kwargs))
+
+    @web.authenticated
+    @check_xsrf
+    def delete(self, **kwargs):
+        self.__model.remove(**kwargs)
+        self.write({"status": True})
+
+    @web.authenticated
+    @check_xsrf
+    def get(self, **kwargs):
+        self.write(json.dumps(self.__model.get(**kwargs)))
+
+    @web.authenticated
+    @check_xsrf
+    def put(self, **kwargs):
+        self.write(self.__model.new(**kwargs))
+
+
+class BaseApiListHandler(E2xApiHandler):
+    def initialize(self, model_cls):
+        self.__model = model_cls(self.coursedir)
+
+    @web.authenticated
+    @check_xsrf
+    def get(self, **kwargs):
+        self.write(json.dumps(self.__model.list(**kwargs)))

{e2xauthoring-0.1.0/e2xauthoring/app → e2xauthoring-0.2.0.dev0/e2xauthoring/app/handlers}/handlers.py

@@ -1,9 +1,7 @@
 import os
 import sys
-from email.policy import default
 
-from e2xgrader.server_extensions.grader.apps.authoring.handlers import app_url
-from e2xgrader.utils import urljoin
+from e2xcore.utils import urljoin
 from nbgrader.server_extensions.formgrader.base import (
     BaseHandler,
     check_notebook_dir,
@@ -11,6 +9,8 @@ from nbgrader.server_extensions.formgrader.base import (
 )
 from tornado import web
 
+app_url = urljoin("e2x", "authoring", "app")
+
 
 class AuthoringHandler(BaseHandler):
     @web.authenticated

e2xauthoring-0.2.0.dev0/e2xauthoring/converters/__init__.py

@@ -0,0 +1,4 @@
+from .converter import Converter
+from .generateexercise import GenerateExercise
+
+__all__ = ["Converter", "GenerateExercise"]

e2xauthoring-0.2.0.dev0/e2xauthoring/converters/converter.py

@@ -0,0 +1,28 @@
+from traitlets import List
+from traitlets.config import Config, LoggingConfigurable
+from traitlets.utils.importstring import import_item
+
+
+class Converter(LoggingConfigurable):
+    preprocessors = List([], help="List of preprocessors for the converter")
+
+    def __init__(self, config=None):
+        with_default_config = self.default_config()
+        if config:
+            with_default_config.merge(config)
+        self.init_preprocessors()
+
+    def init_preprocessors(self):
+        self._preprocessors = []
+        for preprocessor in self.preprocessors:
+            if isinstance(preprocessor, type):
+                self._preprocessors.append(preprocessor())
+            else:
+                self._preprocessors.append(import_item(preprocessor)())
+
+    def default_config(self):
+        return Config()
+
+    def convert(self, resources):
+        for preprocessor in self._preprocessors:
+            preprocessor.preprocess(resources)

e2xauthoring-0.2.0.dev0/e2xauthoring/converters/generateexercise.py

@@ -0,0 +1,40 @@
+import tempfile
+
+from traitlets import List
+
+from ..preprocessors import (
+    AddTaskHeader,
+    CopyFiles,
+    CopyNotebooks,
+    FillTemplate,
+    GenerateTaskIDs,
+    MakeExercise,
+    RemoveExercise,
+)
+from .converter import Converter
+
+
+class GenerateExercise(Converter):
+    preprocessors = List(
+        [
+            RemoveExercise,
+            CopyNotebooks,
+            FillTemplate,
+            CopyFiles,
+            GenerateTaskIDs,
+            AddTaskHeader,
+            MakeExercise,
+        ]
+    )
+
+    def __init__(self, coursedir, config=None):
+        super(GenerateExercise, self).__init__(config=config)
+        self.coursedir = coursedir
+
+    def convert(self, resources):
+        with tempfile.TemporaryDirectory() as tmp:
+            resources["tmp_dir"] = tmp
+            resources["course_prefix"] = self.coursedir.root
+            resources["source_dir"] = self.coursedir.source_directory
+            for preprocessor in self._preprocessors:
+                preprocessor.preprocess(resources)

e2xauthoring-0.2.0.dev0/e2xauthoring/models/__init__.py

@@ -0,0 +1,15 @@
+from .assignmentmodel import AssignmentModel
+from .exercisemodel import ExerciseModel
+from .presetmodel import PresetModel
+from .taskmodel import TaskModel
+from .taskpoolmodel import TaskPoolModel
+from .templatemodel import TemplateModel
+
+__all__ = [
+    "AssignmentModel",
+    "ExerciseModel",
+    "PresetModel",
+    "TaskModel",
+    "TaskPoolModel",
+    "TemplateModel",
+]

e2xauthoring-0.2.0.dev0/e2xauthoring/models/assignmentmodel.py

@@ -0,0 +1,34 @@
+import glob
+import os
+
+from traitlets import Unicode
+
+from .basemodel import BaseModel
+
+
+class AssignmentModel(BaseModel):
+    directory = Unicode("source", help="The directory where assignments go.")
+
+    def __get_assignment_info(self, assignment):
+        return len(glob.glob(os.path.join(self.base_path(), assignment, "*.ipynb")))
+
+    def list(self, **kwargs):
+        if not os.path.isdir(self.base_path()):
+            os.makedirs(self.base_path(), exist_ok=True)
+        assignmentfolders = os.listdir(self.base_path())
+        assignments = []
+        for assignmentfolder in assignmentfolders:
+            if assignmentfolder.startswith("."):
+                continue
+            exercises = self.__get_assignment_info(assignmentfolder)
+            assignments.append(
+                {
+                    "name": assignmentfolder,
+                    "exercises": exercises,
+                    "link": os.path.join(
+                        "taskcreator", "assignments", assignmentfolder
+                    ),
+                }
+            )
+
+        return assignments

e2xauthoring-0.2.0.dev0/e2xauthoring/models/basemodel.py

@@ -0,0 +1,20 @@
+import re
+
+from e2xcore.utils.utils import get_nbgrader_config
+from traitlets import Unicode
+from traitlets.config import LoggingConfigurable
+
+
+class BaseModel(LoggingConfigurable):
+    directory = Unicode(".", help="The directory of the model")
+
+    def __init__(self, coursedir):
+        self.coursedir = coursedir
+        self.__pattern = re.compile(r"^\w+[\w\s]*\w+$")
+        self.config = get_nbgrader_config()
+
+    def base_path(self):
+        return self.coursedir.format_path(self.directory, ".", ".")
+
+    def is_valid_name(self, name):
+        return self.__pattern.match(name) is not None

e2xauthoring-0.2.0.dev0/e2xauthoring/models/dataclasses/__init__.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+from typing import Dict
+
+
+@dataclass
+class Template:
+    name: str
+
+
+@dataclass
+class TaskPool:
+    name: str
+    n_tasks: int
+
+
+@dataclass
+class Task:
+    name: str
+    pool: str
+    points: int
+    n_questions: int
+    git_status: Dict
+
+
+@dataclass
+class Exercise:
+    name: str
+    assignment: str

e2xauthoring-0.2.0.dev0/e2xauthoring/models/dataclasses/message.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class SuccessMessage:
+    success: bool = True
+    message: str = ""
+
+
+@dataclass
+class ErrorMessage:
+    success: bool = False
+    error: str = ""

e2xauthoring-0.2.0.dev0/e2xauthoring/models/dataclasses/template.py

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Template:
+    name: str

e2xauthoring-0.2.0.dev0/e2xauthoring/models/exercisemodel.py

@@ -0,0 +1,44 @@
+import glob
+import os
+import shutil
+
+from traitlets import Unicode
+
+from .basemodel import BaseModel
+
+
+class ExerciseModel(BaseModel):
+    directory = Unicode("source", help="The directory where assignments go.")
+
+    def get(self, **kwargs):
+        return {"name": kwargs["name"], "assignment": kwargs["assignment"]}
+
+    def remove(self, **kwargs):
+        assignment = kwargs["assignment"]
+        name = kwargs["name"]
+        base_path = os.path.join(self.base_path(), assignment)
+        exercise_files = os.path.join(base_path, "{}_files".format(name))
+        if os.path.exists(exercise_files):
+            shutil.rmtree(exercise_files)
+        exercise = os.path.join(base_path, "{}.ipynb".format(name))
+        if os.path.exists(exercise):
+            os.remove(exercise)
+
+    def list(self, **kwargs):
+        assignment = kwargs["assignment"]
+        base_path = os.path.join(self.base_path(), assignment)
+        exercisenbs = glob.glob(os.path.join(base_path, "*.ipynb"))
+        exercises = []
+        for exercisenb in exercisenbs:
+            name = os.path.split(exercisenb)[-1].replace(".ipynb", "")
+            exercises.append(
+                {
+                    "name": name,
+                    "assignment": assignment,
+                    "link": os.path.join(
+                        "taskcreator", "assignments", assignment, name
+                    ),
+                }
+            )
+
+        return exercises

e2xauthoring-0.2.0.dev0/e2xauthoring/models/lister/lister.py

@@ -0,0 +1,27 @@
+import os
+from abc import abstractmethod
+from typing import List
+
+from nbgrader.coursedir import CourseDirectory
+from traitlets import Unicode
+from traitlets.config import LoggingConfigurable
+
+
+class Lister(LoggingConfigurable):
+    directory = Unicode(".", help="The directory of the items to list")
+
+    def __init__(self, coursedir: CourseDirectory) -> None:
+        self.coursedir = coursedir
+
+    @property
+    def base_path(self):
+        return self.coursedir.format_path(self.directory, ".", ".")
+
+    def listdir(self, path: str) -> List[str]:
+        return [
+            directory for directory in os.listdir(path) if not directory.startswith(".")
+        ]
+
+    @abstractmethod
+    def list_items(self, **kwargs):
+        pass

e2xauthoring-0.2.0.dev0/e2xauthoring/models/lister/taskpoollister.py

@@ -0,0 +1,33 @@
+import os
+from typing import List
+
+from traitlets import Unicode
+
+from ...utils.gitutils import is_version_controlled
+from ..dataclasses import TaskPool
+from .lister import Lister
+
+
+class TaskPoolLister(Lister):
+    directory = Unicode(
+        "pools", help="The relative directory where the pools are stored"
+    )
+
+    def __get_n_tasks(self, name):
+        return len(
+            [
+                d
+                for d in os.listdir(os.path.join(self.base_path, name))
+                if not d.startswith(".")
+            ]
+        )
+
+    def list_items(self, **kwargs) -> List[TaskPool]:
+        return [
+            TaskPool(
+                name=pool_dir,
+                n_tasks=self.__get_n_tasks(pool_dir),
+                is_repo=is_version_controlled(os.path.join(self.base_path, pool_dir)),
+            )
+            for pool_dir in self.listdir(self.base_path)
+        ]

e2xauthoring-0.2.0.dev0/e2xauthoring/models/lister/templatelister.py

@@ -0,0 +1,17 @@
+from typing import List
+
+from traitlets import Unicode
+
+from ..dataclasses.template import Template
+from .lister import Lister
+
+
+class TemplateLister(Lister):
+    directory = Unicode(
+        "templates", help="The relative directory where the templates are stored"
+    )
+
+    def list_items(self, **kwargs) -> List[Template]:
+        return [
+            Template(name=template_dir) for template_dir in self.listdir(self.base_path)
+        ]

e2xauthoring-0.2.0.dev0/e2xauthoring/models/managers/manager.py

@@ -0,0 +1,40 @@
+import os
+import re
+from abc import abstractmethod
+from typing import List
+
+from nbgrader.coursedir import CourseDirectory
+from traitlets import Unicode
+from traitlets.config import LoggingConfigurable
+
+
+class BaseManager(LoggingConfigurable):
+    directory = Unicode(".", help="The directory of the items to manage")
+
+    def __init__(self, coursedir: CourseDirectory) -> None:
+        self.coursedir = coursedir
+        self.__pattern = re.compile(r"^\w+[\w\s]*\w+$")
+
+    @property
+    def base_path(self):
+        return self.coursedir.format_path(self.directory, ".", ".")
+
+    def is_valid_name(self, name):
+        return self.__pattern.match(name) is not None
+
+    def listdir(self, path: str) -> List[str]:
+        return [
+            directory for directory in os.listdir(path) if not directory.startswith(".")
+        ]
+
+    @abstractmethod
+    def create(self, **kwargs):
+        pass
+
+    @abstractmethod
+    def remove(self, **kwargs):
+        pass
+
+    @abstractmethod
+    def list(self, **kwargs):
+        pass