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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. tutor_notes-19.0.1/.gitignore +7 -0
  2. {tutor-notes-18.0.0/tutor_notes.egg-info → tutor_notes-19.0.1}/PKG-INFO +22 -20
  3. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/README.rst +4 -4
  4. tutor_notes-19.0.1/pyproject.toml +63 -0
  5. tutor_notes-19.0.1/tutornotes/__about__.py +1 -0
  6. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/local-docker-compose-jobs-services +3 -0
  7. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/local-docker-compose-services +3 -0
  8. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/plugin.py +1 -1
  9. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/templates/notes/apps/settings/tutor.py +8 -6
  10. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/templates/notes/build/notes/Dockerfile +14 -11
  11. tutor_notes-19.0.1/tutornotes/templates/notes/tasks/notes/init +4 -0
  12. tutor-notes-18.0.0/MANIFEST.in +0 -2
  13. tutor-notes-18.0.0/PKG-INFO +0 -91
  14. tutor-notes-18.0.0/pyproject.toml +0 -2
  15. tutor-notes-18.0.0/setup.cfg +0 -4
  16. tutor-notes-18.0.0/setup.py +0 -50
  17. tutor-notes-18.0.0/tutor_notes.egg-info/SOURCES.txt +0 -33
  18. tutor-notes-18.0.0/tutor_notes.egg-info/dependency_links.txt +0 -1
  19. tutor-notes-18.0.0/tutor_notes.egg-info/entry_points.txt +0 -2
  20. tutor-notes-18.0.0/tutor_notes.egg-info/requires.txt +0 -4
  21. tutor-notes-18.0.0/tutor_notes.egg-info/top_level.txt +0 -1
  22. tutor-notes-18.0.0/tutornotes/__about__.py +0 -1
  23. tutor-notes-18.0.0/tutornotes/templates/notes/tasks/notes/init +0 -2
  24. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/LICENSE.txt +0 -0
  25. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/__init__.py +0 -0
  26. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/caddyfile +0 -0
  27. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/k8s-deployments +0 -0
  28. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/k8s-jobs +0 -0
  29. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/k8s-services +0 -0
  30. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/kustomization-configmapgenerator +0 -0
  31. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/local-docker-compose-dev-services +0 -0
  32. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/local-docker-compose-permissions-command +0 -0
  33. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/local-docker-compose-permissions-volumes +0 -0
  34. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/openedx-common-settings +0 -0
  35. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/openedx-lms-common-settings +0 -0
  36. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/openedx-lms-development-settings +0 -0
  37. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/patches/openedx-lms-production-settings +0 -0
  38. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/templates/notes/tasks/lms/init +0 -0
  39. {tutor-notes-18.0.0 → tutor_notes-19.0.1}/tutornotes/templates/notes/tasks/mysql/init +0 -0
@@ -0,0 +1,7 @@
1
+ .*.swp
2
+ !.gitignore
3
+ TODO
4
+ __pycache__
5
+ *.egg-info/
6
+ /build/
7
+ /dist/
@@ -1,38 +1,40 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: tutor-notes
3
- Version: 18.0.0
3
+ Version: 19.0.1
4
4
  Summary: A Tutor plugin for student notes
5
- Home-page: https://docs.tutor.edly.io/
6
- Author: Overhang.IO
7
- Author-email: contact@overhang.io
8
- Maintainer: eduNEXT
9
- License: AGPLv3
10
- Project-URL: Documentation, https://docs.tutor.edly.io/
11
- Project-URL: Code, https://github.com/overhangio/tutor-notes
12
- Project-URL: Issue tracker, https://github.com/overhangio/tutor-notes/issues
13
- Project-URL: Community, https://discuss.openedx.org
5
+ Project-URL: Homepage, https://docs.tutor.edly.io/
6
+ Project-URL: Documentation, https://github.com/overhangio/tutor-notes#readme
7
+ Project-URL: Issues, https://github.com/overhangio/tutor-notes/issues
8
+ Project-URL: Source, https://github.com/overhangio/tutor-notes
9
+ Project-URL: Changelog, https://github.com/overhangio/tutor-notes/blob/release/CHANGELOG.md
10
+ Project-URL: Community, https://discuss.openedx.org/tag/tutor
11
+ Author: Edly
12
+ Author-email: hello@edly.io
13
+ Maintainer: Jhony Avella
14
+ Maintainer-email: jhony.avella@edunext.co
15
+ License: AGPL-3.0-only
16
+ License-File: LICENSE.txt
14
17
  Classifier: Development Status :: 5 - Production/Stable
15
18
  Classifier: Intended Audience :: Developers
16
19
  Classifier: License :: OSI Approved :: GNU Affero General Public License v3
17
20
  Classifier: Operating System :: OS Independent
18
21
  Classifier: Programming Language :: Python
19
- Classifier: Programming Language :: Python :: 3.8
20
22
  Classifier: Programming Language :: Python :: 3.9
21
23
  Classifier: Programming Language :: Python :: 3.10
22
24
  Classifier: Programming Language :: Python :: 3.11
23
25
  Classifier: Programming Language :: Python :: 3.12
24
- Requires-Python: >=3.8
25
- License-File: LICENSE.txt
26
- Requires-Dist: tutor<19.0.0,>=18.0.0
26
+ Requires-Python: >=3.9
27
+ Requires-Dist: tutor<20.0.0,>=19.0.0
27
28
  Provides-Extra: dev
28
- Requires-Dist: tutor[dev]<19.0.0,>=18.0.0; extra == "dev"
29
+ Requires-Dist: tutor[dev]<20.0.0,>=19.0.0; extra == 'dev'
30
+ Description-Content-Type: text/x-rst
29
31
 
30
32
  Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
31
33
  ===================================================================
32
34
 
33
- 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>`_).
35
+ 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>`_).
34
36
 
35
- .. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
37
+ .. image:: https://docs.openedx.org/en/latest/_images/SFD_SN_bodyexample.png
36
38
  :alt: Notes in action
37
39
 
38
40
  Installation
@@ -52,7 +54,7 @@ Then, to make migrations & tasks::
52
54
 
53
55
  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.
54
56
 
55
- 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.
57
+ 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.
56
58
 
57
59
  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".
58
60
 
@@ -88,4 +90,4 @@ This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edune
88
90
  License
89
91
  -------
90
92
 
91
- This software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-notes/blob/master/LICENSE.txt>`_.
93
+ 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>`_.
@@ -1,9 +1,9 @@
1
1
  Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
2
2
  ===================================================================
3
3
 
4
- 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>`_).
4
+ 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>`_).
5
5
 
6
- .. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
6
+ .. image:: https://docs.openedx.org/en/latest/_images/SFD_SN_bodyexample.png
7
7
  :alt: Notes in action
8
8
 
9
9
  Installation
@@ -23,7 +23,7 @@ Then, to make migrations & tasks::
23
23
 
24
24
  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.
25
25
 
26
- 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.
26
+ 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.
27
27
 
28
28
  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".
29
29
 
@@ -59,4 +59,4 @@ This Tutor plugin is maintained by Jhony Avella from `eduNEXT <https://www.edune
59
59
  License
60
60
  -------
61
61
 
62
- This software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-notes/blob/master/LICENSE.txt>`_.
62
+ 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>`_.
@@ -0,0 +1,63 @@
1
+ # https://packaging.python.org/en/latest/tutorials/packaging-projects/
2
+ # https://hatch.pypa.io/latest/config/build/
3
+
4
+ [project]
5
+ name = "tutor-notes"
6
+ description = "A Tutor plugin for student notes"
7
+ authors = [
8
+ { name = "Edly" },
9
+ { email = "hello@edly.io"},
10
+ ]
11
+ maintainers = [
12
+ { name = "Jhony Avella" },
13
+ { email = "jhony.avella@edunext.co" },
14
+ ]
15
+ license = {text = "AGPL-3.0-only"}
16
+ readme = {file = "README.rst", content-type = "text/x-rst"}
17
+ requires-python = ">=3.9"
18
+ classifiers = [
19
+ "Development Status :: 5 - Production/Stable",
20
+ "Intended Audience :: Developers",
21
+ "License :: OSI Approved :: GNU Affero General Public License v3",
22
+ "Operating System :: OS Independent",
23
+ "Programming Language :: Python",
24
+ "Programming Language :: Python :: 3.9",
25
+ "Programming Language :: Python :: 3.10",
26
+ "Programming Language :: Python :: 3.11",
27
+ "Programming Language :: Python :: 3.12",
28
+ ]
29
+ dependencies = [
30
+ "tutor>=19.0.0,<20.0.0",
31
+ ]
32
+ optional-dependencies = { dev = ["tutor[dev]>=19.0.0,<20.0.0"] }
33
+
34
+ # These fields will be set by hatch_build.py
35
+ dynamic = ["version"]
36
+
37
+ # https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
38
+ [project.urls]
39
+ Homepage = "https://docs.tutor.edly.io/"
40
+ Documentation = "https://github.com/overhangio/tutor-notes#readme"
41
+ Issues = "https://github.com/overhangio/tutor-notes/issues"
42
+ Source = "https://github.com/overhangio/tutor-notes"
43
+ Changelog = "https://github.com/overhangio/tutor-notes/blob/release/CHANGELOG.md"
44
+ Community = "https://discuss.openedx.org/tag/tutor"
45
+
46
+ [build-system]
47
+ requires = ["hatchling"]
48
+ build-backend = "hatchling.build"
49
+
50
+ # hatch-specific configuration
51
+ [tool.hatch.metadata.hooks.custom]
52
+ path = ".hatch_build.py"
53
+
54
+ [tool.hatch.build.targets.wheel]
55
+ packages = ["tutornotes"]
56
+
57
+ [tool.hatch.build.targets.sdist]
58
+ # Disable strict naming, otherwise twine is not able to detect name/version
59
+ strict-naming = false
60
+ include = [ "/tutornotes"]
61
+
62
+ [project.entry-points."tutor.plugin.v1"]
63
+ notes = "tutornotes.plugin"
@@ -0,0 +1 @@
1
+ __version__ = "19.0.1"
@@ -4,4 +4,7 @@ notes-job:
4
4
  DJANGO_SETTINGS_MODULE: notesserver.settings.tutor
5
5
  volumes:
6
6
  - ../plugins/notes/apps/settings/tutor.py:/app/edx-notes-api/notesserver/settings/tutor.py:ro
7
+ {%- for mount in iter_mounts(MOUNTS, "notes") %}
8
+ - {{ mount }}
9
+ {%- endfor %}
7
10
  depends_on: {{ [("mysql", RUN_MYSQL)]|list_if }}
@@ -6,5 +6,8 @@ notes:
6
6
  volumes:
7
7
  - ../plugins/notes/apps/settings/tutor.py:/app/edx-notes-api/notesserver/settings/tutor.py:ro
8
8
  - ../../data/notes:/app/data
9
+ {%- for mount in iter_mounts(MOUNTS, "notes") %}
10
+ - {{ mount }}
11
+ {%- endfor %}
9
12
  restart: unless-stopped
10
13
  depends_on: {{ [("mysql", RUN_MYSQL)]|list_if }}
@@ -10,7 +10,7 @@ from tutor.__about__ import __version_suffix__
10
10
 
11
11
  from .__about__ import __version__
12
12
 
13
- # Handle version suffix in nightly mode, just like tutor core
13
+ # Handle version suffix in main mode, just like tutor core
14
14
  if __version_suffix__:
15
15
  __version__ += "-" + __version_suffix__
16
16
 
@@ -4,13 +4,14 @@ SECRET_KEY = "{{ NOTES_SECRET_KEY }}"
4
4
  ALLOWED_HOSTS = [
5
5
  "notes",
6
6
  "{{ NOTES_HOST }}",
7
+ "{{ NOTES_HOST }}:8120",
7
8
  ]
8
9
 
9
10
  DATABASES = {
10
11
  "default": {
11
12
  "ENGINE": "django.db.backends.mysql",
12
13
  "HOST": "{{ MYSQL_HOST }}",
13
- "PORT": {{MYSQL_PORT}},
14
+ "PORT": {{ MYSQL_PORT }},
14
15
  "NAME": "{{ NOTES_MYSQL_DATABASE }}",
15
16
  "USER": "{{ NOTES_MYSQL_USERNAME }}",
16
17
  "PASSWORD": "{{ NOTES_MYSQL_PASSWORD }}",
@@ -23,11 +24,12 @@ DATABASES = {
23
24
  CLIENT_ID = "notes"
24
25
  CLIENT_SECRET = "{{ NOTES_OAUTH2_SECRET }}"
25
26
 
26
- ELASTICSEARCH_DSL = {
27
- 'default': {
28
- 'hosts': '{{ ELASTICSEARCH_SCHEME }}://{{ ELASTICSEARCH_HOST }}:{{ ELASTICSEARCH_PORT }}'
29
- }
30
- }
27
+ # Meilisearch credentials
28
+ ES_DISABLED = True
29
+ MEILISEARCH_ENABLED = True
30
+ MEILISEARCH_URL = "{{ MEILISEARCH_URL }}"
31
+ MEILISEARCH_API_KEY = "{{ MEILISEARCH_API_KEY }}"
32
+ MEILISEARCH_INDEX = "{{ MEILISEARCH_INDEX_PREFIX }}student_notes"
31
33
 
32
34
  LOGGING = {
33
35
  "version": 1,
@@ -1,21 +1,24 @@
1
1
  # syntax=docker/dockerfile:1.4
2
- FROM docker.io/python:3.12-slim-bookworm
2
+ FROM docker.io/ubuntu:24.04
3
3
 
4
4
  ENV DEBIAN_FRONTEND=noninteractive
5
+
6
+ # Delete default UID=1000 `ubuntu` user to ensure we can use id 1000 for app user
7
+ RUN userdel -r ubuntu
8
+
5
9
  RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
6
10
  --mount=type=cache,target=/var/lib/apt,sharing=locked \
7
11
  apt update && \
8
12
  apt upgrade -y && \
9
13
  apt install -y \
10
- locales \
14
+ language-pack-en \
11
15
  git \
12
- python3-dev \
13
- build-essential \
14
- default-libmysqlclient-dev \
15
- pkg-config && \
16
- sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && \
17
- locale-gen
18
- ENV LC_ALL en_US.UTF-8
16
+ python3 \
17
+ python3-pip \
18
+ python3-venv \
19
+ libmysqlclient-dev \
20
+ pkg-config
21
+ RUN ln -s /usr/bin/python3 /usr/bin/python
19
22
 
20
23
  ###### Git-clone Notes repo ######
21
24
  ARG APP_USER_ID=1000
@@ -27,11 +30,11 @@ WORKDIR /app/edx-notes-api
27
30
 
28
31
  ###### Install python venv ######
29
32
  RUN python -m venv /app/venv
30
- ENV PATH /app/venv/bin:${PATH}
33
+ ENV PATH=/app/venv/bin:${PATH}
31
34
  # https://pypi.org/project/setuptools/
32
35
  # https://pypi.org/project/pip/
33
36
  # https://pypi.org/project/wheel/
34
- RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install setuptools==69.2.0 pip==24.0 wheel==0.43.0
37
+ RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install setuptools==75.2.0 pip==24.2 wheel==0.44.0
35
38
  RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install -r requirements/base.txt
36
39
 
37
40
  EXPOSE 8000
@@ -0,0 +1,4 @@
1
+ ./manage.py migrate
2
+
3
+ # Re-index with meilisearch
4
+ ./manage.py shell -c "from notesapi.v1.views.meilisearch import reindex; reindex()"
@@ -1,2 +0,0 @@
1
- recursive-include tutornotes/patches *
2
- recursive-include tutornotes/templates *
@@ -1,91 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: tutor-notes
3
- Version: 18.0.0
4
- Summary: A Tutor plugin for student notes
5
- Home-page: https://docs.tutor.edly.io/
6
- Author: Overhang.IO
7
- Author-email: contact@overhang.io
8
- Maintainer: eduNEXT
9
- License: AGPLv3
10
- Project-URL: Documentation, https://docs.tutor.edly.io/
11
- Project-URL: Code, https://github.com/overhangio/tutor-notes
12
- Project-URL: Issue tracker, https://github.com/overhangio/tutor-notes/issues
13
- Project-URL: Community, https://discuss.openedx.org
14
- Classifier: Development Status :: 5 - Production/Stable
15
- Classifier: Intended Audience :: Developers
16
- Classifier: License :: OSI Approved :: GNU Affero General Public License v3
17
- Classifier: Operating System :: OS Independent
18
- Classifier: Programming Language :: Python
19
- Classifier: Programming Language :: Python :: 3.8
20
- Classifier: Programming Language :: Python :: 3.9
21
- Classifier: Programming Language :: Python :: 3.10
22
- Classifier: Programming Language :: Python :: 3.11
23
- Classifier: Programming Language :: Python :: 3.12
24
- Requires-Python: >=3.8
25
- License-File: LICENSE.txt
26
- Requires-Dist: tutor<19.0.0,>=18.0.0
27
- Provides-Extra: dev
28
- Requires-Dist: tutor[dev]<19.0.0,>=18.0.0; extra == "dev"
29
-
30
- Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
31
- ===================================================================
32
-
33
- 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>`_).
34
-
35
- .. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-redwood.master/_images/SFD_SN_bodyexample.png
36
- :alt: Notes in action
37
-
38
- Installation
39
- ------------
40
-
41
- 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::
42
-
43
- tutor plugins install notes
44
-
45
- Then, to enable this plugin, run::
46
-
47
- tutor plugins enable notes
48
-
49
- Then, to make migrations & tasks::
50
-
51
- tutor local launch
52
-
53
- 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.
54
-
55
- 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.
56
-
57
- 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".
58
-
59
- Configuration
60
- -------------
61
-
62
- - ``NOTES_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``)
63
- - ``NOTES_SECRET_KEY`` (default: ``"{{ 24|random_string }}"``)
64
- - ``NOTES_OAUTH2_SECRET`` (default: ``"{{ 24|random_string }}"``)
65
- - ``NOTES_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}"``)
66
- - ``NOTES_HOST`` (default: ``"notes.{{ LMS_HOST }}"``)
67
- - ``NOTES_MYSQL_DATABASE`` (default: ``"notes"``)
68
- - ``NOTES_MYSQL_USERNAME`` (default: ``"notes"``)
69
- - ``NOTES_REPOSITORY`` (default: ``"https://github.com/openedx/edx-notes-api"``)
70
- - ``NOTES_REPOSITORY_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``)
71
-
72
- These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.
73
-
74
- Debugging
75
- ---------
76
-
77
- To debug the notes API service, you are encouraged to mount the edx-notes-api repo from the host in the development container:
78
-
79
- tutor dev start --mount /path/to/edx-notes-api
80
-
81
- Feel free to add breakpoints (``breakpoint()``) anywhere in your source code to debug your application.
82
-
83
- Troubleshooting
84
- ---------------
85
-
86
- 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.
87
-
88
- License
89
- -------
90
-
91
- This software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-notes/blob/master/LICENSE.txt>`_.
@@ -1,2 +0,0 @@
1
- [build-system]
2
- requires = ["setuptools", "wheel"]
@@ -1,4 +0,0 @@
1
- [egg_info]
2
- tag_build =
3
- tag_date = 0
4
-
@@ -1,50 +0,0 @@
1
- import io
2
- import os
3
- from setuptools import setup, find_packages
4
-
5
- here = os.path.abspath(os.path.dirname(__file__))
6
-
7
- with io.open(os.path.join(here, "README.rst"), "rt", encoding="utf8") as f:
8
- readme = f.read()
9
-
10
- about = {}
11
- with io.open(
12
- os.path.join(here, "tutornotes", "__about__.py"), "rt", encoding="utf-8"
13
- ) as f:
14
- exec(f.read(), about)
15
-
16
- setup(
17
- name="tutor-notes",
18
- version=about["__version__"],
19
- url="https://docs.tutor.edly.io/",
20
- project_urls={
21
- "Documentation": "https://docs.tutor.edly.io/",
22
- "Code": "https://github.com/overhangio/tutor-notes",
23
- "Issue tracker": "https://github.com/overhangio/tutor-notes/issues",
24
- "Community": "https://discuss.openedx.org",
25
- },
26
- license="AGPLv3",
27
- author="Overhang.IO",
28
- author_email="contact@overhang.io",
29
- maintainer="eduNEXT",
30
- description="A Tutor plugin for student notes",
31
- long_description=readme,
32
- packages=find_packages(exclude=["tests*"]),
33
- include_package_data=True,
34
- python_requires=">=3.8",
35
- install_requires=["tutor>=18.0.0,<19.0.0"],
36
- extras_require={"dev": ["tutor[dev]>=18.0.0,<19.0.0"]},
37
- entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]},
38
- classifiers=[
39
- "Development Status :: 5 - Production/Stable",
40
- "Intended Audience :: Developers",
41
- "License :: OSI Approved :: GNU Affero General Public License v3",
42
- "Operating System :: OS Independent",
43
- "Programming Language :: Python",
44
- "Programming Language :: Python :: 3.8",
45
- "Programming Language :: Python :: 3.9",
46
- "Programming Language :: Python :: 3.10",
47
- "Programming Language :: Python :: 3.11",
48
- "Programming Language :: Python :: 3.12",
49
- ],
50
- )
@@ -1,33 +0,0 @@
1
- LICENSE.txt
2
- MANIFEST.in
3
- README.rst
4
- pyproject.toml
5
- setup.py
6
- tutor_notes.egg-info/PKG-INFO
7
- tutor_notes.egg-info/SOURCES.txt
8
- tutor_notes.egg-info/dependency_links.txt
9
- tutor_notes.egg-info/entry_points.txt
10
- tutor_notes.egg-info/requires.txt
11
- tutor_notes.egg-info/top_level.txt
12
- tutornotes/__about__.py
13
- tutornotes/__init__.py
14
- tutornotes/plugin.py
15
- tutornotes/patches/caddyfile
16
- tutornotes/patches/k8s-deployments
17
- tutornotes/patches/k8s-jobs
18
- tutornotes/patches/k8s-services
19
- tutornotes/patches/kustomization-configmapgenerator
20
- tutornotes/patches/local-docker-compose-dev-services
21
- tutornotes/patches/local-docker-compose-jobs-services
22
- tutornotes/patches/local-docker-compose-permissions-command
23
- tutornotes/patches/local-docker-compose-permissions-volumes
24
- tutornotes/patches/local-docker-compose-services
25
- tutornotes/patches/openedx-common-settings
26
- tutornotes/patches/openedx-lms-common-settings
27
- tutornotes/patches/openedx-lms-development-settings
28
- tutornotes/patches/openedx-lms-production-settings
29
- tutornotes/templates/notes/apps/settings/tutor.py
30
- tutornotes/templates/notes/build/notes/Dockerfile
31
- tutornotes/templates/notes/tasks/lms/init
32
- tutornotes/templates/notes/tasks/mysql/init
33
- tutornotes/templates/notes/tasks/notes/init
@@ -1,2 +0,0 @@
1
- [tutor.plugin.v1]
2
- notes = tutornotes.plugin
@@ -1,4 +0,0 @@
1
- tutor<19.0.0,>=18.0.0
2
-
3
- [dev]
4
- tutor[dev]<19.0.0,>=18.0.0
@@ -1 +0,0 @@
1
- tutornotes
@@ -1 +0,0 @@
1
- __version__ = "18.0.0"
@@ -1,2 +0,0 @@
1
- ./manage.py migrate
2
- ./manage.py search_index --rebuild -f
File without changes