e2xcore 0.0.1__tar.gz

e2xcore-0.0.1/.gitignore

@@ -0,0 +1,139 @@
+# Node modules
+
+node_modules
+
+# Build static files
+e2xgrader/static
+
+# 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/
+
+# vscode
+.vscode/

e2xcore-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    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

e2xcore-0.0.1/.ruff_cache/.gitignore

@@ -0,0 +1 @@
+*

e2xcore-0.0.1/.ruff_cache/CACHEDIR.TAG

@@ -0,0 +1 @@
+Signature: 8a477f597d28d172789f06886806bc55

e2xcore-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 DigiKlausur
+
+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.

e2xcore-0.0.1/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: e2xcore
+Version: 0.0.1
+Summary: An template for a server app for e2xgrader
+Project-URL: Documentation, https://e2x.inf.h-brs.de
+Project-URL: Issues, https://github.com/Digiklausur/e2xcore/issues
+Project-URL: Source, https://github.com/Digiklausur/e2xcore
+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.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Requires-Dist: notebook<7,>=6
+Provides-Extra: dev
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: tbump; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# e2xcore
+
+---
+
+e2xcore combines functionality for writing e2xgrader extensions

e2xcore-0.0.1/README.md

@@ -0,0 +1,5 @@
+# e2xcore
+
+---
+
+e2xcore combines functionality for writing e2xgrader extensions

e2xcore-0.0.1/e2xcore/__init__.py

@@ -0,0 +1,8 @@
+from .app import BaseApp
+from .utils import format_url, urljoin
+
+__all__ = [
+    "BaseApp",
+    "format_url",
+    "urljoin",
+]

e2xcore-0.0.1/e2xcore/__version__.py

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

e2xcore-0.0.1/e2xcore/app.py

@@ -0,0 +1,57 @@
+import abc
+from typing import Any, Dict, List, Tuple
+
+from notebook.base.handlers import IPythonHandler
+from notebook.utils import url_path_join as ujoin
+from traitlets.config import Application
+
+
+class BaseApp(Application):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.log = self.parent.log
+
+    @property
+    def webapp(self):
+        return self.parent.web_app
+
+    def add_handlers(self, handlers: List[Tuple[str, IPythonHandler]]):
+        """
+        Add handlers to the tornado server
+
+        Args:
+            handlers -- a list of handlers
+        """
+
+        def rewrite(x):
+            pat = ujoin(self.webapp.settings["base_url"], x[0].lstrip("/"))
+            return (pat,) + x[1:]
+
+        self.webapp.add_handlers(".*$", [rewrite(x) for x in handlers])
+
+    def update_tornado_settings(self, settings: Dict[Any, Any]):
+        """
+        Update tornado settings
+
+        Args:
+            settings -- a settings dictionary used to update
+                        the current tornado settings
+        """
+        self.webapp.settings.update(settings)
+
+    def add_template_path(self, path: str):
+        """
+        Add a template path to the jinja environment
+
+        Args:
+                path -- the absolute path to the template directory
+        """
+        self.webapp.settings["e2xgrader"]["jinja_env"].loader.searchpath.append(path)
+
+    @abc.abstractmethod
+    def load_app(self):
+        """
+        This method is called when the app is loaded.
+        Use it to initialize your app with handlers, settings, etc.
+        """
+        pass

e2xcore-0.0.1/e2xcore/handlers/__init__.py

@@ -0,0 +1,3 @@
+from .base import E2xHandler
+
+__all__ = ["E2xHandler"]

e2xcore-0.0.1/e2xcore/handlers/base.py

@@ -0,0 +1,19 @@
+from notebook.base.handlers import IPythonHandler
+
+
+class E2xHandler(IPythonHandler):
+    @property
+    def e2xgrader_settings(self):
+        return self.settings["e2xgrader"]
+
+    @property
+    def jinja_env(self):
+        return self.e2xgrader_settings["jinja_env"]
+
+    @property
+    def menu(self):
+        return self.e2xgrader_settings["menu"]
+
+    def render(self, name, **ns):
+        template = self.jinja_env.get_template(name)
+        return template.render(**ns)

e2xcore-0.0.1/e2xcore/utils.py

@@ -0,0 +1,35 @@
+import re
+from typing import Any, Dict, List
+from urllib.parse import parse_qsl, urlencode, urlparse
+
+
+def format_url(url: str, params: Dict[str, Any]) -> str:
+    """Join a url with search parameters
+
+    Args:
+        url (str): The url
+        params (Dict[str, Any]): A dictionary of parameters
+
+    Returns:
+        str: The url with encoded search parameters
+    """
+    parsed = urlparse(url)
+    return parsed._replace(
+        query=urlencode({**dict(parse_qsl(parsed.query)), **params})
+    ).geturl()
+
+
+def urljoin(*parts: List[str]) -> str:
+    """Join a list of parts to produce an url
+
+    Args:
+        *parts (List[str]) - a list of parts
+
+    Returns:
+        str: url with leading slash
+
+    Example:
+        >>> urljoin("e2x", "api", "v1")
+        '/e2x/api/v1'
+    """
+    return re.sub(r"/+", r"/", ("/" + "/".join(parts)))

e2xcore-0.0.1/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "e2xcore"
+description = "An template for a server app for e2xgrader"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+authors = [
+  { name = "Tim Metzler", email = "tim.metzler@h-brs.de" },
+]
+classifiers=[
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11"
+]
+dependencies = [
+    "notebook>=6,<7",
+]
+dynamic = ["version"]
+
+[project.urls]
+Documentation = "https://e2x.inf.h-brs.de"
+Issues = "https://github.com/Digiklausur/e2xcore/issues"
+Source = "https://github.com/Digiklausur/e2xcore"
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "hatchling",
+    "tbump"
+]
+
+[tool.hatch.version]
+path = "e2xcore/__version__.py"
+
+[tool.tbump]
+# Uncomment this if your project is hosted on GitHub:
+# github_url = "https://github.com/<user or organization>/<project>/"
+
+[tool.tbump.version]
+current = "0.0.1"
+
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  (?P<dev>-dev\d+)?
+  '''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "v{new_version}"
+
+# Files with the version present
+[[tool.tbump.file]]
+src = "e2xcore/__version__.py"
+
+[tool.ruff]
+line-length = 100
+ignore-init-module-imports = true
+select = ["F", "E", "I"]