edx-platform

Files

Kyle McCormick c70bfe980a build!: Switch to openedx-core (renamed from openedx-learning) (#38011 )

build!: Switch to openedx-core (renamed from openedx-learning)

Instead of installing openedx-learning==0.32.0, we install openedx-core==0.34.1.
We update various class names, function names, docstrings, and comments to
represent the rename:

* We say "openedx-core" when referring to the whole repo or PyPI project
  * or occasionally "Open edX Core" if we want it to look nice in the docs.
* We say "openedx_content" to refer to the Content API within openedx-core,
   which is actually the thing we have been calling "Learning Core" all along.
  * In snake-case code, it's `*_openedx_content_*`.
  * In camel-case code, it's `*OpenedXContent*`

For consistency's sake we avoid anything else like oex_core, OeXCore,
OpenEdXCore, OexContent, openedx-content, OpenEdxContent, etc.
There should be no more references to learning_core, learning-core, Learning Core,
Learning-Core, LC, openedx-learning, openedx_learning, etc.

BREAKING CHANGE: for openedx-learning/openedx-core developers:
You may need to uninstall openedx-learning and re-install openedx-core
from your venv. If running tutor, you may need to un-mount openedx-learning,
rename the directory to openedx-core, re-mount it, and re-build.
The code APIs themselves are fully backwards-compatible.

Part of: https://github.com/openedx/openedx-core/issues/470

2026-02-18 22:38:25 +00:00

__init__.py

…

api_urls.py

feat: Django codemods on LMS (3) (#28853 )

2021-11-16 18:27:21 +05:00

decorators.py

refactor: rename descriptor -> block within lms/djangoapps/edxnotes

2023-04-26 17:10:53 +02:00

exceptions.py

BOM-2279 : Pylint amnesty for edxnotes,email_marketing, and experiments (#26274 )

2021-02-03 18:15:26 +05:00

helpers.py

fix: Update naming for courseware section/subsection.

2025-08-07 15:35:04 -04:00

plugins.py

chore: Applied lint-amnesty on lms/djangoapps/{edxnotes, experiments}

2021-12-20 16:05:02 +05:00

README.rst

chore: cleanup

2024-05-25 18:08:25 +03:30

tests.py

build!: Switch to openedx-core (renamed from openedx-learning) (#38011 )

2026-02-18 22:38:25 +00:00

urls.py

feat: Django codemods on LMS (3) (#28853 )

2021-11-16 18:27:21 +05:00

views.py

Update all edx-platform REST endpoints to support JWT Auth (#34152 )

2024-02-13 10:46:58 -05:00

README.rst

Status: Maintenance

Responsibilities
================

The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in storing the notes is done by a separate service (see the `edx-notes-api`_ repo).

.. _edx-notes-api: https://github.com/openedx/edx-notes-api/

Direction: Extract into Plugin
==============================

Notes needs to insert a new tab into the LMS courseware, as well as wrap/decorate the courseware XBlock output so that it can add annotation capability to it.
Both of these can now be done via plugins (decorating XBlock output can be done with XBlock Asides), and this app should be extracted into a separate repository.

This app is also currently proxying some requests through the LMS instead of hitting its service endpoint directly.
It should instead always let the user's browser hit the edx-notes-api service directly.

The edxnotes app also has an endpoint to get JWT tokens that the edx-notes-api will accept.
This should be removed, and the edx-notes-api service converted to use the OAuth2 + JWT Cookie approach detailed in the `Transport JWT in HTTP Cookies`_ decision record for ``oauth_dispatch``.

.. _Transport JWT in HTTP Cookies: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/oauth_dispatch/docs/decisions/0009-jwt-in-session-cookie.rst

Glossary
========

More Documentation
==================