| Name | tutor-notes JSON |
| Version |
19.0.0
JSON |
| download |
| home_page | https://docs.tutor.edly.io/ |
| Summary | A Tutor plugin for student notes |
| upload_time | 2024-12-16 21:04:48 |
| maintainer | eduNEXT |
| docs_url | None |
| author | Edly |
| requires_python | >=3.9 |
| license | AGPLv3 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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>`_.
Raw data
{
"_id": null,
"home_page": "https://docs.tutor.edly.io/",
"name": "tutor-notes",
"maintainer": "eduNEXT",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Edly",
"author_email": "hello@edly.io",
"download_url": "https://files.pythonhosted.org/packages/c6/63/4c2c22470e526c4d756505215db4ef62bf6365497ed46810b0fe4adb8c68/tutor_notes-19.0.0.tar.gz",
"platform": null,
"description": "Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_\n===================================================================\n\nThis 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>`_).\n\n.. image:: https://docs.openedx.org/en/latest/_images/SFD_SN_bodyexample.png\n :alt: Notes in action\n\nInstallation\n------------\n\nThe 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::\n\n tutor plugins install notes\n\nThen, to enable this plugin, run::\n\n tutor plugins enable notes\n\nThen, to make migrations & tasks::\n\n tutor local launch\n\nYou 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.\n\nIf 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.\n\nTo 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\".\n\nConfiguration\n-------------\n\n- ``NOTES_MYSQL_PASSWORD`` (default: ``\"{{ 8|random_string }}\"``)\n- ``NOTES_SECRET_KEY`` (default: ``\"{{ 24|random_string }}\"``)\n- ``NOTES_OAUTH2_SECRET`` (default: ``\"{{ 24|random_string }}\"``)\n- ``NOTES_DOCKER_IMAGE`` (default: ``\"{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}\"``)\n- ``NOTES_HOST`` (default: ``\"notes.{{ LMS_HOST }}\"``)\n- ``NOTES_MYSQL_DATABASE`` (default: ``\"notes\"``)\n- ``NOTES_MYSQL_USERNAME`` (default: ``\"notes\"``)\n- ``NOTES_REPOSITORY`` (default: ``\"https://github.com/openedx/edx-notes-api\"``)\n- ``NOTES_REPOSITORY_VERSION`` (default: ``\"{{ OPENEDX_COMMON_VERSION }}\"``)\n\nThese values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.\n\nDebugging\n---------\n\nTo debug the notes API service, you are encouraged to mount the edx-notes-api repo from the host in the development container:\n\n tutor dev start --mount /path/to/edx-notes-api\n\nFeel free to add breakpoints (``breakpoint()``) anywhere in your source code to debug your application.\n\nTroubleshooting\n---------------\n\nThis 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.\n\nLicense\n-------\n\nThis software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-notes/blob/release/LICENSE.txt>`_.\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "A Tutor plugin for student notes",
"version": "19.0.0",
"project_urls": {
"Code": "https://github.com/overhangio/tutor-notes",
"Community": "https://discuss.openedx.org",
"Documentation": "https://docs.tutor.edly.io/",
"Homepage": "https://docs.tutor.edly.io/",
"Issue tracker": "https://github.com/overhangio/tutor-notes/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6634c2c22470e526c4d756505215db4ef62bf6365497ed46810b0fe4adb8c68",
"md5": "0a4b8cae193295859a805a20002cc8f9",
"sha256": "73d8993fc3768f0f4f48e2b68c613b23f1d2bc29b9d22daa62e0944d1902a1d3"
},
"downloads": -1,
"filename": "tutor_notes-19.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0a4b8cae193295859a805a20002cc8f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20252,
"upload_time": "2024-12-16T21:04:48",
"upload_time_iso_8601": "2024-12-16T21:04:48.432636Z",
"url": "https://files.pythonhosted.org/packages/c6/63/4c2c22470e526c4d756505215db4ef62bf6365497ed46810b0fe4adb8c68/tutor_notes-19.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 21:04:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "overhangio",
"github_project": "tutor-notes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tutor-notes"
}
