tutor-notes 19.0.0__tar.gz → 19.0.2__tar.gz

tutor_notes-19.0.2/.gitignore

@@ -0,0 +1,7 @@
+.*.swp
+!.gitignore
+TODO
+__pycache__
+*.egg-info/
+/build/
+/dist/

tutor_notes-19.0.2/.hatch_build.py

@@ -0,0 +1,21 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+
+import os
+import typing as t
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+HERE = os.path.dirname(__file__)
+
+
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        about = load_about()
+        metadata["version"] = about["__version__"]
+
+
+def load_about() -> dict[str, str]:
+    about: dict[str, str] = {}
+    with open(os.path.join(HERE, "tutornotes", "__about__.py"), "rt", encoding="utf-8") as f:
+        exec(f.read(), about)  # pylint: disable=exec-used
+    return about

{tutor_notes-19.0.0/tutor_notes.egg-info → tutor_notes-19.0.2}/PKG-INFO

@@ -1,16 +1,19 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tutor-notes
-Version: 19.0.0
+Version: 19.0.2
 Summary: A Tutor plugin for student notes
-Home-page: https://docs.tutor.edly.io/
+Project-URL: Homepage, https://docs.tutor.edly.io/
+Project-URL: Documentation, https://github.com/overhangio/tutor-notes#readme
+Project-URL: Issues, https://github.com/overhangio/tutor-notes/issues
+Project-URL: Source, https://github.com/overhangio/tutor-notes
+Project-URL: Changelog, https://github.com/overhangio/tutor-notes/blob/release/CHANGELOG.md
+Project-URL: Community, https://discuss.openedx.org/tag/tutor
 Author: Edly
 Author-email: hello@edly.io
-Maintainer: eduNEXT
-License: AGPLv3
-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
+Maintainer: Jhony Avella
+Maintainer-email: jhony.avella@edunext.co
+License: AGPL-3.0-only
+License-File: LICENSE.txt
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
@@ -21,11 +24,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
-License-File: LICENSE.txt
 Requires-Dist: tutor<20.0.0,>=19.0.0
 Provides-Extra: dev
-Requires-Dist: tutor[dev]<20.0.0,>=19.0.0; extra == "dev"
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: tutor[dev]<20.0.0,>=19.0.0; extra == 'dev'
+Description-Content-Type: text/x-rst
 
 Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
 ===================================================================

tutor_notes-19.0.2/pyproject.toml

@@ -0,0 +1,71 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+# https://hatch.pypa.io/latest/config/build/
+
+[project]
+name = "tutor-notes"
+description = "A Tutor plugin for student notes"
+authors = [
+  { name = "Edly" },
+  { email = "hello@edly.io"},
+]
+maintainers = [
+  { name = "Jhony Avella" },
+  { email = "jhony.avella@edunext.co" },
+]
+license = {text = "AGPL-3.0-only"}
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+  "tutor>=19.0.0,<20.0.0",
+]
+
+# These fields will be set by hatch_build.py
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+    "tutor[dev]>=19.0.0,<20.0.0",
+    "black",
+    "pylint"
+]
+
+
+# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
+[project.urls]
+Homepage = "https://docs.tutor.edly.io/"
+Documentation = "https://github.com/overhangio/tutor-notes#readme"
+Issues = "https://github.com/overhangio/tutor-notes/issues"
+Source = "https://github.com/overhangio/tutor-notes"
+Changelog = "https://github.com/overhangio/tutor-notes/blob/release/CHANGELOG.md"
+Community = "https://discuss.openedx.org/tag/tutor"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# hatch-specific configuration
+[tool.hatch.metadata.hooks.custom]
+path = ".hatch_build.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["tutornotes"]
+
+[tool.hatch.build.targets.sdist]
+# Disable strict naming, otherwise twine is not able to detect name/version
+strict-naming = false
+include = [ "/tutornotes", ".hatch_build.py"]
+exclude = ["tests*"]
+
+[project.entry-points."tutor.plugin.v1"]
+notes = "tutornotes.plugin"

tutor_notes-19.0.2/tutornotes/__about__.py

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

{tutor_notes-19.0.0 → tutor_notes-19.0.2}/tutornotes/templates/notes/apps/settings/tutor.py

@@ -4,6 +4,7 @@ SECRET_KEY = "{{ NOTES_SECRET_KEY }}"
 ALLOWED_HOSTS = [
     "notes",
     "{{ NOTES_HOST }}",
+    "{{ NOTES_HOST }}:8120",
 ]
 
 DATABASES = {

tutor_notes-19.0.0/MANIFEST.in

@@ -1,2 +0,0 @@
-recursive-include tutornotes/patches *
-recursive-include tutornotes/templates *

tutor_notes-19.0.0/PKG-INFO

@@ -1,91 +0,0 @@
-Metadata-Version: 2.1
-Name: tutor-notes
-Version: 19.0.0
-Summary: A Tutor plugin for student notes
-Home-page: https://docs.tutor.edly.io/
-Author: Edly
-Author-email: hello@edly.io
-Maintainer: eduNEXT
-License: AGPLv3
-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
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
-Description-Content-Type: text/x-rst
-License-File: LICENSE.txt
-Requires-Dist: tutor<20.0.0,>=19.0.0
-Provides-Extra: dev
-Requires-Dist: tutor[dev]<20.0.0,>=19.0.0; extra == "dev"
-
-Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
-===================================================================
-
-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://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/enable_notes.html>`_).
-
-.. image:: https://docs.openedx.org/en/latest/_images/SFD_SN_bodyexample.png
-    :alt: Notes in action
-
-Installation
-------------
-
-The plugin is currently bundled with the `binary releases of Tutor <https://github.com/overhangio/tutor/releases>`_. If you have installed Tutor from source, you will have to install this plugin from source, too::
-
-    tutor plugins install notes
-
-Then, to enable this plugin, run::
-
-    tutor plugins enable notes
-
-Then, to make migrations & tasks::
-
-    tutor local launch
-
-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.openedx.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".
-
-Configuration
--------------
-
-- ``NOTES_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``)
-- ``NOTES_SECRET_KEY`` (default: ``"{{ 24|random_string }}"``)
-- ``NOTES_OAUTH2_SECRET`` (default: ``"{{ 24|random_string }}"``)
-- ``NOTES_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}"``)
-- ``NOTES_HOST`` (default: ``"notes.{{ LMS_HOST }}"``)
-- ``NOTES_MYSQL_DATABASE`` (default: ``"notes"``)
-- ``NOTES_MYSQL_USERNAME`` (default: ``"notes"``)
-- ``NOTES_REPOSITORY`` (default: ``"https://github.com/openedx/edx-notes-api"``)
-- ``NOTES_REPOSITORY_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``)
-
-These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.
-
-Debugging
----------
-
-To debug the notes API service, you are encouraged to mount the edx-notes-api repo from the host in the development container:
-
-    tutor dev start --mount /path/to/edx-notes-api
-
-Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to debug your application.
-
-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.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
-
-License
--------
-
-This software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-notes/blob/release/LICENSE.txt>`_.

tutor_notes-19.0.0/pyproject.toml

@@ -1,2 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]

tutor_notes-19.0.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

tutor_notes-19.0.0/setup.py

@@ -1,50 +0,0 @@
-import io
-import os
-from setuptools import setup, find_packages
-
-here = os.path.abspath(os.path.dirname(__file__))
-
-with io.open(os.path.join(here, "README.rst"), "rt", encoding="utf8") as f:
-    readme = f.read()
-
-about = {}
-with io.open(
-    os.path.join(here, "tutornotes", "__about__.py"), "rt", encoding="utf-8"
-) as f:
-    exec(f.read(), about)
-
-setup(
-    name="tutor-notes",
-    version=about["__version__"],
-    url="https://docs.tutor.edly.io/",
-    project_urls={
-        "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",
-    },
-    license="AGPLv3",
-    author="Edly",
-    author_email="hello@edly.io",
-    maintainer="eduNEXT",
-    description="A Tutor plugin for student notes",
-    long_description=readme,
-    long_description_content_type="text/x-rst",
-    packages=find_packages(exclude=["tests*"]),
-    include_package_data=True,
-    python_requires=">=3.9",
-    install_requires=["tutor>=19.0.0,<20.0.0"],
-    extras_require={"dev": ["tutor[dev]>=19.0.0,<20.0.0"]},
-    entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]},
-    classifiers=[
-        "Development Status :: 5 - Production/Stable",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: GNU Affero General Public License v3",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-    ],
-)

tutor_notes-19.0.0/tutor_notes.egg-info/SOURCES.txt

@@ -1,33 +0,0 @@
-LICENSE.txt
-MANIFEST.in
-README.rst
-pyproject.toml
-setup.py
-tutor_notes.egg-info/PKG-INFO
-tutor_notes.egg-info/SOURCES.txt
-tutor_notes.egg-info/dependency_links.txt
-tutor_notes.egg-info/entry_points.txt
-tutor_notes.egg-info/requires.txt
-tutor_notes.egg-info/top_level.txt
-tutornotes/__about__.py
-tutornotes/__init__.py
-tutornotes/plugin.py
-tutornotes/patches/caddyfile
-tutornotes/patches/k8s-deployments
-tutornotes/patches/k8s-jobs
-tutornotes/patches/k8s-services
-tutornotes/patches/kustomization-configmapgenerator
-tutornotes/patches/local-docker-compose-dev-services
-tutornotes/patches/local-docker-compose-jobs-services
-tutornotes/patches/local-docker-compose-permissions-command
-tutornotes/patches/local-docker-compose-permissions-volumes
-tutornotes/patches/local-docker-compose-services
-tutornotes/patches/openedx-common-settings
-tutornotes/patches/openedx-lms-common-settings
-tutornotes/patches/openedx-lms-development-settings
-tutornotes/patches/openedx-lms-production-settings
-tutornotes/templates/notes/apps/settings/tutor.py
-tutornotes/templates/notes/build/notes/Dockerfile
-tutornotes/templates/notes/tasks/lms/init
-tutornotes/templates/notes/tasks/mysql/init
-tutornotes/templates/notes/tasks/notes/init

tutor_notes-19.0.0/tutor_notes.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

tutor_notes-19.0.0/tutor_notes.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[tutor.plugin.v1]
-notes = tutornotes.plugin

tutor_notes-19.0.0/tutor_notes.egg-info/requires.txt

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

tutor_notes-19.0.0/tutor_notes.egg-info/top_level.txt

@@ -1 +0,0 @@
-tutornotes

tutor_notes-19.0.0/tutornotes/__about__.py

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