e2xauthoring 0.1.0__tar.gz

e2xauthoring-0.1.0/.github/workflows/sonarcloud.yml

@@ -0,0 +1,68 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow helps you trigger a SonarCloud analysis of your code and populates
+# GitHub Code Scanning alerts with the vulnerabilities found.
+# Free for open source project.
+
+# 1. Login to SonarCloud.io using your GitHub account
+
+# 2. Import your project on SonarCloud
+#     * Add your GitHub organization first, then add your repository as a new project.
+#     * Please note that many languages are eligible for automatic analysis,
+#       which means that the analysis will start automatically without the need to set up GitHub Actions.
+#     * This behavior can be changed in Administration > Analysis Method.
+#
+# 3. Follow the SonarCloud in-product tutorial
+#     * a. Copy/paste the Project Key and the Organization Key into the args parameter below
+#          (You'll find this information in SonarCloud. Click on "Information" at the bottom left)
+#
+#     * b. Generate a new token and add it to your Github repository's secrets using the name SONAR_TOKEN
+#          (On SonarCloud, click on your avatar on top-right > My account > Security
+#           or go directly to https://sonarcloud.io/account/security/)
+
+# Feel free to take a look at our documentation (https://docs.sonarcloud.io/getting-started/github/)
+# or reach out to our community forum if you need some help (https://community.sonarsource.com/c/help/sc/9)
+
+name: SonarCloud analysis
+
+on:
+  push:
+    branches: [ "main", "dev" ]
+  pull_request:
+    branches: [ "main", "dev" ]
+  workflow_dispatch:
+
+permissions:
+  pull-requests: read # allows SonarCloud to decorate PRs with analysis results
+
+jobs:
+  Analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Analyze with SonarCloud
+
+        # You can pin the exact commit or the version.
+        # uses: SonarSource/sonarcloud-github-action@de2e56b42aa84d0b1c5b622644ac17e505c9a049
+        uses: SonarSource/sonarcloud-github-action@de2e56b42aa84d0b1c5b622644ac17e505c9a049
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}   # Generate a token on Sonarcloud.io, add it to the secrets of this repo with the name SONAR_TOKEN (Settings > Secrets > Actions > add new repository secret)
+        with:
+          # Additional arguments for the sonarcloud scanner
+          args:
+            # Unique keys of your project and organization. You can find them in SonarCloud > Information (bottom-left menu)
+            # mandatory
+            -Dsonar.projectKey=DigiKlausur_e2xauthoring
+            -Dsonar.organization=digiklausur
+            # Comma-separated paths to directories containing main source files.
+            #-Dsonar.sources= # optional, default is project base directory
+            # When you need the analysis to take place in a directory other than the one from which it was launched
+            #-Dsonar.projectBaseDir= # optional, default is .
+            # Comma-separated paths to directories containing test source files.
+            #-Dsonar.tests= # optional. For more info about Code Coverage, please refer to https://docs.sonarcloud.io/enriching/test-coverage/overview/
+            # Adds more detail to both client and server-side analysis logs, activating DEBUG mode for the scanner, and adding client-side environment variables and system properties to the server-side log of analysis report processing.
+            #-Dsonar.verbose= # optional, default is false

e2xauthoring-0.1.0/.gitignore

@@ -0,0 +1,133 @@
+# Dynamic files
+e2xauthoring/app/templates
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+node_modules

e2xauthoring-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        files: \.py$
+        args: [--profile=black]
+
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier
+        entry: 'npm run prettier:files'
+        language: node
+        types_or: [json, markdown, ts, tsx, javascript, jsx, css]

e2xauthoring-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Tim Metzler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

e2xauthoring-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include e2xauthoring/app/templates *

e2xauthoring-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: e2xauthoring
+Version: 0.1.0
+Summary: Authoring app for e2xgrader
+Project-URL: Source, https://github.com/Digiklausur/e2xauthoring
+Author-email: Tim Metzler <tim.metzler@h-brs.de>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: gitpython
+Provides-Extra: dev
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# e2xauthoring
+
+---
+
+This is an authoring component for e2xgrader

e2xauthoring-0.1.0/README.md

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

e2xauthoring-0.1.0/e2xauthoring/__version__.py

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

e2xauthoring-0.1.0/e2xauthoring/app/__init__.py

@@ -0,0 +1,3 @@
+from .authoring import AuthoringApp
+
+__all__ = ["AuthoringApp"]

e2xauthoring-0.1.0/e2xauthoring/app/apihandlers.py

@@ -0,0 +1,225 @@
+import json
+
+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 nbgrader.server_extensions.formgrader.base import check_xsrf
+from tornado import web
+
+from e2xauthoring.utils import get_author, set_author
+
+from ..models import TaskModel, TaskPoolModel
+
+
+class ManagePoolsHandler(E2xApiHandler):
+    def initialize(self) -> None:
+        self.__poolmodel = TaskPoolModel(self.coursedir)
+
+    @web.authenticated
+    @check_xsrf
+    def get(self, action):
+        if action == "list":
+            self.write(json.dumps(self.__poolmodel.list()))
+        elif action == "get":
+            self.write(json.dumps(self.__poolmodel.get(pool=self.get_argument("pool"))))
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+    @web.authenticated
+    @check_xsrf
+    def post(self, action):
+        data = self.get_json_body()
+        name = data.get("name")
+        if action == "new":
+            create_repository = data.get("create_repository", False)
+            self.write(
+                json.dumps(
+                    self.__poolmodel.new(name=name, create_repository=create_repository)
+                )
+            )
+        elif action == "remove":
+            self.write(json.dumps(self.__poolmodel.remove(name=name)))
+        elif action == "init_repo":
+            self.write(json.dumps(self.__poolmodel.turn_into_repository(name)))
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+
+class ManageTasksHandler(E2xApiHandler):
+    def initialize(self) -> None:
+        self.__model = TaskModel(self.coursedir)
+
+    @web.authenticated
+    @check_xsrf
+    def get(self, action):
+        if action == "list":
+            self.write(json.dumps(self.__model.list(pool=self.get_argument("pool"))))
+        elif action == "list_all":
+            tasks = []
+            pool_model = TaskPoolModel(self.coursedir)
+            for pool in pool_model.list():
+                tasks.extend(self.__model.list(pool["name"]))
+            self.write(json.dumps(tasks))
+        elif action == "get":
+            self.write(
+                json.dumps(
+                    self.__model.get(
+                        pool=self.get_argument("pool"), name=self.get_argument("name")
+                    )
+                )
+            )
+        elif action == "diff":
+            self.write(
+                json.dumps(
+                    self.__model.git_diff(
+                        pool=self.get_argument("pool"),
+                        task=self.get_argument("task"),
+                        file=self.get_argument("file"),
+                    )
+                )
+            )
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+    @web.authenticated
+    @check_xsrf
+    def post(self, action):
+        data = self.get_json_body()
+        name = data.get("name")
+        pool = data.get("pool")
+        if action == "new":
+            self.write(json.dumps(self.__model.new(pool=pool, name=name)))
+        elif action == "remove":
+            self.write(json.dumps(self.__model.remove(pool=pool, name=name)))
+        elif action == "commit":
+            message = data.get("message", None)
+            self.write(
+                json.dumps(self.__model.commit(pool=pool, task=name, message=message))
+            )
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+
+class ManageTemplatesHandler(E2xApiHandler):
+    def initialize(self) -> None:
+        self.__model = TemplateModel(self.coursedir)
+
+    @web.authenticated
+    @check_xsrf
+    def get(self, action):
+        if action == "list":
+            self.write(json.dumps(self.__model.list()))
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+    @web.authenticated
+    @check_xsrf
+    def post(self, action):
+        data = self.get_json_body()
+        name = data.get("name")
+        if action == "new":
+            self.write(json.dumps(self.__model.new(name=name)))
+        elif action == "remove":
+            self.write(json.dumps(self.__model.remove(name=name)))
+        else:
+            self.write(
+                json.dumps(
+                    dict(status="error", message=f"{action} is not a valid action")
+                )
+            )
+
+
+class GenerateExerciseHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def post(self):
+        GenerateExercise(coursedir=self.coursedir).convert(self.get_json_body())
+        self.write(dict(success=True))
+
+
+class GitAuthorHandler(E2xApiHandler):
+    @web.authenticated
+    @check_xsrf
+    def get(self):
+        self.write(json.dumps(get_author()))
+
+    @web.authenticated
+    @check_xsrf
+    def post(self):
+        data = self.get_json_body()
+        name = data.get("name")
+        email = data.get("email")
+        self.write(json.dumps(set_author(name=name, email=email)))
+
+
+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)"
+default_handlers = [
+    (urljoin(api_url, "presets"), PresetHandler),
+    (
+        urljoin(api_url, "assignments", "?"),
+        BaseApiListHandler,
+        dict(model_cls=AssignmentModel),
+    ),
+    (
+        urljoin(api_url, "template", name_regex, "?"),
+        BaseApiManageHandler,
+        dict(model_cls=TemplateModel),
+    ),
+    (
+        urljoin(api_url, "templates", "?"),
+        BaseApiListHandler,
+        dict(model_cls=TemplateModel),
+    ),
+    (
+        urljoin(api_url, "worksheets", assignment_regex, name_regex, "?"),
+        BaseApiManageHandler,
+        dict(model_cls=ExerciseModel),
+    ),
+    (
+        urljoin(api_url, "worksheets", assignment_regex, "?"),
+        BaseApiListHandler,
+        dict(model_cls=ExerciseModel),
+    ),
+    (urljoin(api_url, "pools", pool_action_regex, "?"), ManagePoolsHandler),
+    (urljoin(api_url, "tasks", task_action_regex, "?"), ManageTasksHandler),
+    (urljoin(api_url, "templates", template_action_regex, "?"), ManageTemplatesHandler),
+    (urljoin(api_url, "templates", "variables"), TemplateVariableHandler),
+    (urljoin(api_url, "kernelspec"), KernelSpecHandler),
+    (urljoin(api_url, "generate_worksheet"), GenerateExerciseHandler),
+    (urljoin(api_url, "git", "author"), GitAuthorHandler),
+]

e2xauthoring-0.1.0/e2xauthoring/app/authoring.py

@@ -0,0 +1,33 @@
+import os
+
+from e2xgrader.server_extensions.grader.apps.base import BaseApp
+from nbgrader.apps.baseapp import NbGrader
+from tornado import web
+
+from .apihandlers import default_handlers
+from .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")
+
+    def __init__(self, **kwargs) -> None:
+        NbGrader.__init__(self, **kwargs)
+        BaseApp.__init__(self, **kwargs)
+
+    def load_app(self) -> None:
+        self.log.info("Loading the e2xgrader git authoring app")
+        self.add_template_path(self.template_path)
+        self.add_handlers(default_handlers)
+        self.add_handlers(
+            [
+                (
+                    r"/e2x/authoring/static/(.*)",
+                    web.StaticFileHandler,
+                    dict(path=self.static_path),
+                )
+            ]
+        )
+        self.add_handlers(handlers)

e2xauthoring-0.1.0/e2xauthoring/app/handlers.py

@@ -0,0 +1,30 @@
+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 nbgrader.server_extensions.formgrader.base import (
+    BaseHandler,
+    check_notebook_dir,
+    check_xsrf,
+)
+from tornado import web
+
+
+class AuthoringHandler(BaseHandler):
+    @web.authenticated
+    @check_xsrf
+    @check_notebook_dir
+    def get(self):
+        self.write(
+            self.render(
+                os.path.join("authoring", "index.html"),
+                url_prefix=self.url_prefix,
+                base_url=self.base_url,
+                windows=(sys.prefix == "win32"),
+            )
+        )
+
+
+default_handlers = [(urljoin(app_url, "?.*"), AuthoringHandler)]