e2xauthoring 0.2.1__tar.gz → 0.3.0__tar.gz

e2xauthoring-0.3.0/.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: Format with black
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

e2xauthoring-0.3.0/.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Lint with Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1

e2xauthoring-0.3.0/.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

e2xauthoring-0.3.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.3
+Name: e2xauthoring
+Version: 0.3.0
+Summary: Authoring app for e2xgrader
+Project-URL: Source, https://github.com/Digiklausur/e2xauthoring
+Project-URL: Documentation, https://e2xauthoring.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/Digiklausur/e2xauthoring/issues
+Project-URL: Pypi, https://pypi.org/project/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: e2xcore>=0.0.5
+Requires-Dist: gitpython
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pydata-sphinx-theme; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: tbump; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# e2xauthoring
+[![PyPi](https://img.shields.io/pypi/v/e2xauthoring)](https://pypi.org/project/e2xauthoring) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Docs](https://img.shields.io/readthedocs/e2xauthoring)](https://e2xauthoring.readthedocs.io) 
+---
+
+e2xauthoring is an add-on for e2xgrader that adds functionality for authoring assignments.
+e2xauthoring streamlines assignment creation for nbgrader by utilizing reusable components known as *tasks* and *templates*.
+Please refer to the [documenation](https://e2xauthoring.readthedocs.io) for further information.
+## Screenshots
+
+Create a task from question presets:
+![new_task](docs/source/user_docs/img/new_task.png)
+
+<br/>
+
+Creating a worksheet from tasks and a template:
+![new_worksheet](docs/source/user_docs/img/worksheet_options.png)
+
+
+## Requirements
+
+- e2xcore
+
+## Install
+
+The add-on is automatically installed alongside e2xgrader.
+To install it yourself, execute:
+
+```bash
+pip install e2xauthoring
+```
+
+## Uninstall
+
+To uninstall, execute:
+
+```bash
+pip uninstall e2xauthoring
+```
+
+

e2xauthoring-0.3.0/README.md

@@ -0,0 +1,40 @@
+# e2xauthoring
+[![PyPi](https://img.shields.io/pypi/v/e2xauthoring)](https://pypi.org/project/e2xauthoring) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Docs](https://img.shields.io/readthedocs/e2xauthoring)](https://e2xauthoring.readthedocs.io) 
+---
+
+e2xauthoring is an add-on for e2xgrader that adds functionality for authoring assignments.
+e2xauthoring streamlines assignment creation for nbgrader by utilizing reusable components known as *tasks* and *templates*.
+Please refer to the [documenation](https://e2xauthoring.readthedocs.io) for further information.
+## Screenshots
+
+Create a task from question presets:
+![new_task](docs/source/user_docs/img/new_task.png)
+
+<br/>
+
+Creating a worksheet from tasks and a template:
+![new_worksheet](docs/source/user_docs/img/worksheet_options.png)
+
+
+## Requirements
+
+- e2xcore
+
+## Install
+
+The add-on is automatically installed alongside e2xgrader.
+To install it yourself, execute:
+
+```bash
+pip install e2xauthoring
+```
+
+## Uninstall
+
+To uninstall, execute:
+
+```bash
+pip uninstall e2xauthoring
+```
+
+

e2xauthoring-0.3.0/docs/requirements.txt

@@ -0,0 +1 @@
+pydata-sphinx-theme

{e2xauthoring-0.2.1 → e2xauthoring-0.3.0}/docs/source/conf.py

@@ -9,7 +9,8 @@
 project = "e2xauthoring"
 copyright = "2023, Tim Metzler"
 author = "Tim Metzler"
-release = "0.2.1"
+release = "0.3.0"
+github_project_url = "https://github.com/Digiklausur/e2xauthoring"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -25,3 +26,26 @@ exclude_patterns = []
 
 html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
+
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/Digiklausur/e2xgrader",
+            "icon": "fa-brands fa-github",
+        }
+    ],
+    "use_edit_page_button": True,
+    "navbar_align": "left",
+}
+
+html_static_path = ["_static"]
+
+
+html_context = {
+    "github_user": "DigiKlausur",
+    "github_repo": "e2xauthoring",
+    "github_version": "main",
+    "doc_path": "docs/source/",
+}

e2xauthoring-0.2.1/docs/source/user_docs/highlights.rst → e2xauthoring-0.3.0/docs/source/index.rst

@@ -1,7 +1,12 @@
-Highlights
-==========
+.. e2xauthoring documentation master file, created by
+   sphinx-quickstart on Tue Aug 22 15:54:37 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-e2xauthoring streamlines assignment creation for nbgrader by utilizing reusable components known as *tasks* and *templates*.
+e2xauthoring Documentation
+==========================
+
+Welcome to the **e2xauthoring** documentation site. e2xauthoring streamlines assignment creation for nbgrader by utilizing reusable components known as *tasks* and *templates*.
 
 * **Seamless Integration with e2xgrader:** e2xauthoring integrates with e2xgrader, enhancing the process of creating nbgrader assignments.
 * **Efficient Worksheet Creation:** Generate assignments by crafting Jupyter notebook-based worksheets, which serve as individual assignment units.
@@ -12,8 +17,54 @@ e2xauthoring streamlines assignment creation for nbgrader by utilizing reusable
 * **Version Control Ready:** Convert task pools into Git repositories, facilitating version control for collaboration and iteration.
 * **Worksheet Customization:** Assemble worksheets by selecting templates, filling variables, and picking tasks to include, tailoring assignments to specific needs.
 
-.. figure:: img/assignment_worksheets.png
-    :alt: Structure of an assignment
+Screenshots
+-----------
+
+To get a better idea of how e2xauthoring looks like, here are some screenshots.
+
+.. figure:: user_docs/img/assignments.png
+    :alt: Assignments Page
+    :scale: 50%
+
+    Assignments
+
+.. figure:: user_docs/img/tasks.png
+    :alt: Tasks Page
+    :scale: 50%
+
+    Tasks
+
+.. figure:: user_docs/img/templates.png
+    :alt: Templates Page
+    :scale: 50%
+
+    Templates
+
+.. figure:: user_docs/img/add_question.png
+    :alt: Creating a Task
+    :scale: 50%
+
+    Creating a Task
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Documentation:
+
+   user_docs/index
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Setup:
+
+   setup/index
+
+
+
+
 
-    Structure of an assignment created with e2xauthoring
+Indices and tables
+==================
 
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

e2xauthoring-0.3.0/docs/source/setup/index.rst

@@ -0,0 +1,8 @@
+===============
+Getting Started
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   installation

e2xauthoring-0.3.0/docs/source/user_docs/index.rst

@@ -0,0 +1,12 @@
+==================
+User Documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   task
+   pool
+   questions
+   template
+   worksheet

e2xauthoring-0.3.0/e2xauthoring/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

{e2xauthoring-0.2.1 → e2xauthoring-0.3.0}/e2xauthoring/app/handlers/apihandlers.py

@@ -6,6 +6,7 @@ from jupyter_client.kernelspec import KernelSpecManager
 from nbgrader.server_extensions.formgrader.base import check_xsrf
 from tornado import web
 
+from ...git import get_author, set_author
 from ...managers import (
     AssignmentManager,
     PresetManager,
@@ -14,7 +15,6 @@ from ...managers import (
     TemplateManager,
     WorksheetManager,
 )
-from ...utils.gitutils import get_author, set_author
 from .base import ApiManageHandler
 
 

{e2xauthoring-0.2.1 → e2xauthoring-0.3.0}/e2xauthoring/app/handlers/base.py

@@ -1,3 +1,4 @@
+import asyncio
 import inspect
 from typing import List
 
@@ -5,7 +6,7 @@ from e2xcore.handlers import E2xApiHandler
 from nbgrader.server_extensions.formgrader.base import check_xsrf
 from tornado import web
 
-from e2xauthoring.managers.dataclasses import ErrorMessage, SuccessMessage
+from ...dataclasses import ErrorMessage, SuccessMessage
 
 
 def status_msg(method):
@@ -17,14 +18,26 @@ def status_msg(method):
         method: The method to decorate
     """
 
-    def wrapper(*args, **kwargs):
-        try:
-            res = method(*args, **kwargs)
-            return SuccessMessage(data=res)
-        except Exception as e:
-            return ErrorMessage(error=getattr(e, "message", str(e)))
+    if asyncio.iscoroutinefunction(method):
 
-    return wrapper
+        async def async_wrapper(*args, **kwargs):
+            try:
+                res = await method(*args, **kwargs)
+                return SuccessMessage(data=res)
+            except Exception as e:
+                return ErrorMessage(error=getattr(e, "message", str(e)))
+
+        return async_wrapper
+    else:
+
+        def wrapper(*args, **kwargs):
+            try:
+                res = method(*args, **kwargs)
+                return SuccessMessage(data=res)
+            except Exception as e:
+                return ErrorMessage(error=getattr(e, "message", str(e)))
+
+        return wrapper
 
 
 class ApiManageHandler(E2xApiHandler):
@@ -59,16 +72,21 @@ class ApiManageHandler(E2xApiHandler):
             params[arg] = argument
         return params
 
-    def perform_action(self, action: str, allowed_actions: List[str]):
+    async def perform_action(self, action: str, allowed_actions: List[str]):
         assert (
             action is not None and action in allowed_actions
         ), f"Action {action} is not a valid action."
         method = getattr(self.__manager, action)
         arguments = self.extract_arguments(method)
-        return method(**arguments)
+
+        # If the method is async, await it, otherwise call it synchronously
+        if inspect.iscoroutinefunction(method):
+            return await method(**arguments)
+        else:
+            return method(**arguments)
 
     @status_msg
-    def handle_request(self, request_type: str):
+    async def handle_request(self, request_type: str):
         action = self.get_argument(
             "action", default=None  # self.__allowed_actions[request_type]["default"]
         )
@@ -77,26 +95,30 @@ class ApiManageHandler(E2xApiHandler):
                 "action", self.__allowed_actions[request_type]["default"]
             )
 
-        return self.perform_action(
+        return await self.perform_action(
             action, self.__allowed_actions[request_type]["actions"]
         )
 
     @web.authenticated
     @check_xsrf
-    def get(self):
-        self.finish(self.handle_request("get").json())
+    async def get(self):
+        result = await self.handle_request("get")
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
-    def delete(self):
-        self.finish(self.handle_request("delete").json())
+    async def delete(self):
+        result = await self.handle_request("delete")
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
-    def put(self):
-        self.finish(self.handle_request("put").json())
+    async def put(self):
+        result = await self.handle_request("put")
+        self.finish(result.to_json())
 
     @web.authenticated
     @check_xsrf
-    def post(self):
-        self.finish(self.handle_request("post").json())
+    async def post(self):
+        result = await self.handle_request("post")
+        self.finish(result.to_json())

e2xauthoring-0.3.0/e2xauthoring/app/templates/authoring/asset-manifest.json

@@ -0,0 +1,10 @@
+{
+  "files": {
+    "main.js": "/e2x/authoring/static/js/main.b8047c0f.js",
+    "index.html": "/e2x/authoring/index.html",
+    "main.b8047c0f.js.map": "/e2x/authoring/static/js/main.b8047c0f.js.map"
+  },
+  "entrypoints": [
+    "static/js/main.b8047c0f.js"
+  ]
+}

e2xauthoring-0.3.0/e2xauthoring/app/templates/authoring/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="{{base_url}}/e2x/authoring/static/favicon.ico"><title>e²xauthoring</title><script type="text/javascript">window.base_url="{{ base_url }}",window.url_prefix="{{ url_prefix }}",window.webpackstuff="/e2x/authoring/static/js/main.b8047c0f.js"</script><script defer="defer" src="{{base_url}}/e2x/authoring/static/js/main.b8047c0f.js"></script>{%- block head -%} {%- endblock -%}</head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>