tutor-notes 16.0.2__tar.gz → 18.0.0__tar.gz

{tutor-notes-16.0.2/tutor_notes.egg-info → tutor-notes-18.0.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: tutor-notes
-Version: 16.0.2
+Version: 18.0.0
 Summary: A Tutor plugin for student notes
-Home-page: https://docs.tutor.overhang.io/
+Home-page: https://docs.tutor.edly.io/
 Author: Overhang.IO
 Author-email: contact@overhang.io
 Maintainer: eduNEXT
 License: AGPLv3
-Project-URL: Documentation, https://docs.tutor.overhang.io/
+Project-URL: Documentation, https://docs.tutor.edly.io/
 Project-URL: Code, https://github.com/overhangio/tutor-notes
 Project-URL: Issue tracker, https://github.com/overhangio/tutor-notes/issues
 Project-URL: Community, https://discuss.openedx.org
@@ -23,14 +23,16 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 License-File: LICENSE.txt
-Requires-Dist: tutor<17.0.0,>=16.0.0
+Requires-Dist: tutor<19.0.0,>=18.0.0
+Provides-Extra: dev
+Requires-Dist: tutor[dev]<19.0.0,>=18.0.0; extra == "dev"
 
-Students notes plugin for `Tutor <https://docs.tutor.overhang.io>`_
+Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
 ===================================================================
 
-This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/exercises_tools/notes.html>`_).
+This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/exercises_tools/notes.html>`_).
 
-.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/_images/SFD_SN_bodyexample.png
+.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
     :alt: Notes in action
 
 Installation
@@ -50,7 +52,7 @@ Then, to make migrations & tasks::
 
 You should beware that the ``notes.<LMS_HOST>`` domain name should exist and point to your server. For instance, if your LMS is hosted at http://myopenedx.com, the notes service should be found at http://notes.myopenedx.com.
 
-If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.overhang.io.
+If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.edly.io.
 
 To enable student notes for a specific course, you should go to the course advanced settings in the studio, and set "Enable Student Notes" to "true". Then, hit "save changes".
 
@@ -81,7 +83,7 @@ Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to
 Troubleshooting
 ---------------
 
-This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.
+This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
 
 License
 -------

{tutor-notes-16.0.2 → tutor-notes-18.0.0}/README.rst

@@ -1,9 +1,9 @@
-Students notes plugin for `Tutor <https://docs.tutor.overhang.io>`_
+Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
 ===================================================================
 
-This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/exercises_tools/notes.html>`_).
+This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/exercises_tools/notes.html>`_).
 
-.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/_images/SFD_SN_bodyexample.png
+.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
     :alt: Notes in action
 
 Installation
@@ -23,7 +23,7 @@ Then, to make migrations & tasks::
 
 You should beware that the ``notes.<LMS_HOST>`` domain name should exist and point to your server. For instance, if your LMS is hosted at http://myopenedx.com, the notes service should be found at http://notes.myopenedx.com.
 
-If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.overhang.io.
+If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.edly.io.
 
 To enable student notes for a specific course, you should go to the course advanced settings in the studio, and set "Enable Student Notes" to "true". Then, hit "save changes".
 
@@ -54,7 +54,7 @@ Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to
 Troubleshooting
 ---------------
 
-This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.
+This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
 
 License
 -------

{tutor-notes-16.0.2 → tutor-notes-18.0.0}/setup.py

@@ -15,10 +15,10 @@ with io.open(
 
 setup(
     name="tutor-notes",
-    version=about["__package_version__"],
-    url="https://docs.tutor.overhang.io/",
+    version=about["__version__"],
+    url="https://docs.tutor.edly.io/",
     project_urls={
-        "Documentation": "https://docs.tutor.overhang.io/",
+        "Documentation": "https://docs.tutor.edly.io/",
         "Code": "https://github.com/overhangio/tutor-notes",
         "Issue tracker": "https://github.com/overhangio/tutor-notes/issues",
         "Community": "https://discuss.openedx.org",
@@ -32,7 +32,8 @@ setup(
     packages=find_packages(exclude=["tests*"]),
     include_package_data=True,
     python_requires=">=3.8",
-    install_requires=["tutor>=16.0.0,<17.0.0"],
+    install_requires=["tutor>=18.0.0,<19.0.0"],
+    extras_require={"dev": ["tutor[dev]>=18.0.0,<19.0.0"]},
     entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]},
     classifiers=[
         "Development Status :: 5 - Production/Stable",

{tutor-notes-16.0.2 → tutor-notes-18.0.0/tutor_notes.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: tutor-notes
-Version: 16.0.2
+Version: 18.0.0
 Summary: A Tutor plugin for student notes
-Home-page: https://docs.tutor.overhang.io/
+Home-page: https://docs.tutor.edly.io/
 Author: Overhang.IO
 Author-email: contact@overhang.io
 Maintainer: eduNEXT
 License: AGPLv3
-Project-URL: Documentation, https://docs.tutor.overhang.io/
+Project-URL: Documentation, https://docs.tutor.edly.io/
 Project-URL: Code, https://github.com/overhangio/tutor-notes
 Project-URL: Issue tracker, https://github.com/overhangio/tutor-notes/issues
 Project-URL: Community, https://discuss.openedx.org
@@ -23,14 +23,16 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 License-File: LICENSE.txt
-Requires-Dist: tutor<17.0.0,>=16.0.0
+Requires-Dist: tutor<19.0.0,>=18.0.0
+Provides-Extra: dev
+Requires-Dist: tutor[dev]<19.0.0,>=18.0.0; extra == "dev"
 
-Students notes plugin for `Tutor <https://docs.tutor.overhang.io>`_
+Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
 ===================================================================
 
-This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/exercises_tools/notes.html>`_).
+This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/exercises_tools/notes.html>`_).
 
-.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/_images/SFD_SN_bodyexample.png
+.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
     :alt: Notes in action
 
 Installation
@@ -50,7 +52,7 @@ Then, to make migrations & tasks::
 
 You should beware that the ``notes.<LMS_HOST>`` domain name should exist and point to your server. For instance, if your LMS is hosted at http://myopenedx.com, the notes service should be found at http://notes.myopenedx.com.
 
-If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.overhang.io.
+If you would like to host the notes service at a different domain name, you can set the ``NOTES_HOST`` configuration variable (see below). When testing Tutor on a local computer, this will be automatically set to notes.local.edly.io.
 
 To enable student notes for a specific course, you should go to the course advanced settings in the studio, and set "Enable Student Notes" to "true". Then, hit "save changes".
 
@@ -81,7 +83,7 @@ Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to
 Troubleshooting
 ---------------
 
-This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.
+This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edunext.co/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
 
 License
 -------

tutor-notes-18.0.0/tutor_notes.egg-info/requires.txt

@@ -0,0 +1,4 @@
+tutor<19.0.0,>=18.0.0
+
+[dev]
+tutor[dev]<19.0.0,>=18.0.0

tutor-notes-18.0.0/tutornotes/__about__.py

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

{tutor-notes-16.0.2 → tutor-notes-18.0.0}/tutornotes/plugin.py

@@ -1,21 +1,20 @@
 from __future__ import annotations
 
-from glob import glob
 import os
 import typing as t
+from glob import glob
 
-import pkg_resources
-
+import importlib_resources
 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
+if __version_suffix__:
+    __version__ += "-" + __version_suffix__
+
 config = {
-    "unique": {
-        "MYSQL_PASSWORD": "{{ 8|random_string }}",
-        "SECRET_KEY": "{{ 24|random_string }}",
-        "OAUTH2_SECRET": "{{ 24|random_string }}",
-    },
     "defaults": {
         "VERSION": __version__,
         "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}",
@@ -25,49 +24,56 @@ config = {
         "REPOSITORY": "https://github.com/openedx/edx-notes-api",
         "REPOSITORY_VERSION": "{{ OPENEDX_COMMON_VERSION }}",
     },
+    "unique": {
+        "MYSQL_PASSWORD": "{{ 8|random_string }}",
+        "SECRET_KEY": "{{ 24|random_string }}",
+        "OAUTH2_SECRET": "{{ 24|random_string }}",
+    },
 }
 
-# Initialization hooks
-
-# To add a custom initialization task, create a bash script template under:
-# tutorcodejail/templates/codejail/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", ("notes", "tasks", "mysql", "init")),
-    ("lms", ("notes", "tasks", "lms", "init")),
-    ("notes", ("notes", "tasks", "notes", "init")),
-]
-
-# For each task added to MY_INIT_TASKS, we load the task template
+# For each service, 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(
-        "tutornotes", os.path.join("templates", *template_path)
+for service in ["mysql", "lms", "notes"]:
+    full_path: str = str(
+        importlib_resources.files("tutornotes")
+        / "templates"
+        / "notes"
+        / "tasks"
+        / service
+        / "init"
     )
     with open(full_path, encoding="utf-8") as init_task_file:
         init_task: str = init_task_file.read()
     tutor_hooks.Filters.CLI_DO_INIT_TASKS.add_item((service, init_task))
 
 # Image management
-tutor_hooks.Filters.IMAGES_BUILD.add_item((
-    "notes",
-    ("plugins", "notes", "build", "notes"),
-    "{{ NOTES_DOCKER_IMAGE }}",
-    (),
-))
-tutor_hooks.Filters.IMAGES_PULL.add_item((
-    "notes",
-    "{{ NOTES_DOCKER_IMAGE }}",
-))
-tutor_hooks.Filters.IMAGES_PUSH.add_item((
-    "notes",
-    "{{ NOTES_DOCKER_IMAGE }}",
-))
+tutor_hooks.Filters.IMAGES_BUILD.add_item(
+    (
+        "notes",
+        ("plugins", "notes", "build", "notes"),
+        "{{ NOTES_DOCKER_IMAGE }}",
+        (),
+    )
+)
+tutor_hooks.Filters.IMAGES_PULL.add_item(
+    (
+        "notes",
+        "{{ NOTES_DOCKER_IMAGE }}",
+    )
+)
+tutor_hooks.Filters.IMAGES_PUSH.add_item(
+    (
+        "notes",
+        "{{ NOTES_DOCKER_IMAGE }}",
+    )
+)
+
 
 @tutor_hooks.Filters.COMPOSE_MOUNTS.add()
-def _mount_edx_notes_api(volumes, name):
+def _mount_edx_notes_api(
+    volumes: list[tuple[str, str]], name: str
+) -> list[tuple[str, str]]:
     """
     When mounting edx-notes-api with `--mount=/path/to/edx-notes-api`,
     bind-mount the host repo in the notes container.
@@ -80,10 +86,10 @@ def _mount_edx_notes_api(volumes, name):
         ]
     return volumes
 
-####### Boilerplate code
+
 # Add the "templates" folder as a template root
 tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
-    pkg_resources.resource_filename("tutornotes", "templates")
+    str(importlib_resources.files("tutornotes") / "templates")
 )
 # Render the "build" and "apps" folders
 tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
@@ -93,36 +99,29 @@ tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
     ],
 )
 # Load patches from files
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("tutornotes", "patches"),
-        "*",
-    )
-):
+for path in glob(str(importlib_resources.files("tutornotes") / "patches" / "*")):
     with open(path, encoding="utf-8") as patch_file:
         tutor_hooks.Filters.ENV_PATCHES.add_item(
             (os.path.basename(path), patch_file.read())
         )
+
 # Add configuration entries
 tutor_hooks.Filters.CONFIG_DEFAULTS.add_items(
-    [
-        (f"NOTES_{key}", value)
-        for key, value in config.get("defaults", {}).items()
-    ]
+    [(f"NOTES_{key}", value) for key, value in config.get("defaults", {}).items()]
 )
 tutor_hooks.Filters.CONFIG_UNIQUE.add_items(
-    [
-        (f"NOTES_{key}", value)
-        for key, value in config.get("unique", {}).items()
-    ]
+    [(f"NOTES_{key}", value) for key, value in config.get("unique", {}).items()]
 )
 tutor_hooks.Filters.CONFIG_OVERRIDES.add_items(
     list(config.get("overrides", {}).items())
 )
 
+
 # Notes public hosts
 @tutor_hooks.Filters.APP_PUBLIC_HOSTS.add()
-def _notes_public_hosts(hosts: list[str], context_name: t.Literal["local", "dev"]) -> list[str]:
+def _notes_public_hosts(
+    hosts: list[str], context_name: t.Literal["local", "dev"]
+) -> list[str]:
     if context_name == "dev":
         hosts += ["{{ NOTES_HOST }}:8120"]
     else:

tutor-notes-18.0.0/tutornotes/templates/notes/build/notes/Dockerfile

@@ -0,0 +1,38 @@
+# syntax=docker/dockerfile:1.4
+FROM docker.io/python:3.12-slim-bookworm
+
+ENV DEBIAN_FRONTEND=noninteractive
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+  --mount=type=cache,target=/var/lib/apt,sharing=locked \
+  apt update && \
+  apt upgrade -y && \
+  apt install -y \
+    locales \
+    git \
+    python3-dev \
+    build-essential \
+    default-libmysqlclient-dev \
+    pkg-config && \
+  sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && \
+  locale-gen
+ENV LC_ALL en_US.UTF-8
+
+###### Git-clone Notes repo ######
+ARG APP_USER_ID=1000
+RUN useradd --home-dir /app --create-home --shell /bin/bash --uid ${APP_USER_ID} app
+USER ${APP_USER_ID}
+
+RUN git clone {{ NOTES_REPOSITORY }} --branch {{ NOTES_REPOSITORY_VERSION }} --depth 1 /app/edx-notes-api
+WORKDIR /app/edx-notes-api
+
+###### Install python venv ######
+RUN python -m venv /app/venv
+ENV PATH /app/venv/bin:${PATH}
+# https://pypi.org/project/setuptools/
+# https://pypi.org/project/pip/
+# https://pypi.org/project/wheel/
+RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install setuptools==69.2.0 pip==24.0 wheel==0.43.0
+RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install -r requirements/base.txt
+
+EXPOSE 8000
+CMD gunicorn --workers=2 --name notes --bind=0.0.0.0:8000 --max-requests=1000 notesserver.wsgi:application

tutor-notes-16.0.2/tutor_notes.egg-info/requires.txt

@@ -1 +0,0 @@
-tutor<17.0.0,>=16.0.0

tutor-notes-16.0.2/tutornotes/__about__.py

@@ -1,8 +0,0 @@
-__version__ = "16.0.2"
-__package_version__ = __version__
-
-# Handle version suffix for nightly, just like tutor core.
-__version_suffix__ = ""
-
-if __version_suffix__:
-    __version__ += "-" + __version_suffix__

tutor-notes-16.0.2/tutornotes/templates/notes/build/notes/Dockerfile

@@ -1,30 +0,0 @@
-{% if is_buildkit_enabled() %}# syntax=docker/dockerfile:1.4{% endif %}
-FROM docker.io/ubuntu:20.04
-
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
-  --mount=type=cache,target=/var/lib/apt,sharing=locked{% endif %} \
-  apt update && \
-  apt upgrade -y && \
-  # python 3.8
-  apt install -y language-pack-en git python3 python3-pip python3-venv libmysqlclient-dev
-RUN ln -s /usr/bin/python3 /usr/bin/python
-
-###### Git-clone Notes repo ######
-ARG APP_USER_ID=1000
-RUN useradd --home-dir /app --create-home --shell /bin/bash --uid ${APP_USER_ID} app
-USER ${APP_USER_ID}
-
-RUN git clone {{ NOTES_REPOSITORY }} --branch {{ NOTES_REPOSITORY_VERSION }} --depth 1 /app/edx-notes-api
-WORKDIR /app/edx-notes-api
-
-###### Install python venv ######
-RUN python -m venv /app/venv
-ENV PATH /app/venv/bin:${PATH}
-# https://pypi.org/project/setuptools/
-# https://pypi.org/project/pip/
-# https://pypi.org/project/wheel/
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install setuptools==67.8.0 pip==23.1.2 wheel==0.40.0
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install -r requirements/base.txt
-
-EXPOSE 8000
-CMD gunicorn --workers=2 --name notes --bind=0.0.0.0:8000 --max-requests=1000 notesserver.wsgi:application