You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To represent the increasing scope of this repository, we are renaming it from
openedx-learning to openedx-core. Practically, this commit:
* Updates GitHub hyperlinks in this repo from openedx/openedx-learning -> openedx/openedx-core
* Publishes a new PyPI project called openedx-core, version starting at 0.34
* Publishes a final PyPI release of openedx-learning, versioned 0.33, which is
empty and just installs openedx-core as a dependency
* Updates "Learning Core" to "Open edX Core" in various docs and comments
* Updates various docs and comments to represent the project's new scope.
BREAKING CHANGE: openedx-learning==0.33.0 will be the final release of openedx-learning.
It will transitively install openedx-core==0.34.0 (fully code-compatible) and
not receive updates going forward. In order to receive updates, operators
should install openedx-core instead.
Part of: #470
The ``openedx-learning`` project holds Django apps that represent core learning platform concepts.
10
+
*Formerly known as "Learning Core" or "openedx-learning".*
11
+
12
+
The ``openedx-core`` project holds Django apps which represent core teaching & learning platform concepts.
13
+
14
+
Each app exposes stable, public API of Python functions and Django models. Some apps additionally provides REST APIs. These APIs are suitable for use in ``openedx-platform`` as well as in community-developed Open edX plugins.
11
15
12
16
Motivation
13
17
----------
14
18
15
-
The short term goal of this project is to create a small, extensible core that is easier to reason about and write extensions for than openedx-platform. The longer term goal is to create a more nimble core learning platform, enabling rapid experimentation and drastic changes to the learner experience that are difficult to implement with Open edX today.
19
+
The short term goal of this project is to create a small, extensible core that is easier to reason about and write extensions for than ``openedx-platform``. The longer term goal is to create a more nimble core learning platform, enabling rapid experimentation and drastic changes to the learner experience that are difficult to implement with Open edX today.
16
20
17
-
Replacing openedx-platform is explicitly *not* a goal of this project, as only a small fraction of the concepts in openedx-platform make sense to carry over here. When these core concepts are extracted and the data migrated, openedx-platform will import apps from this repo and make use of their public in-process APIs.
21
+
Replacing ``openedx-platform`` is explicitly *not* a goal of this project, as only a small fraction of the concepts in openedx-platform make sense to carry over here. When these core concepts are extracted and the data migrated, openedx-platform will import apps from this repo and make use of their public in-process APIs.
18
22
19
23
Architecture
20
24
------------
21
25
22
-
Learning Core Package Dependencies
26
+
Open edX Core Package Dependencies
23
27
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
28
25
-
Learning Core code should never import from ``openedx-platform``.
29
+
Open edX Core code should never import from ``openedx-platform``.
26
30
27
31
We want to be very strict about dependency management internally as well. Please read the `.importlinter config file <.importlinter>`_ file and the `Python API Conventions ADR <docs/decisions/0016-python-public-api-conventions>`_ for more details.
28
32
@@ -37,7 +41,6 @@ We have a few different identifier types in the schema, and we try to avoid ``_i
37
41
* ``key`` is intended to be a case-sensitive, alphanumeric key, which holds some meaning to library clients. This is usually stable, but can be changed, depending on the business logic of the client. The apps in this repo should make no assumptions about it being stable. It can be used as a suffix. Since ``key`` is a reserved name on certain database systems, the database field is ``_key``.
38
42
* ``num`` is like ``key``, but for use when it's strictly numeric. It can also be used as a suffix.
39
43
40
-
41
44
See Also
42
45
~~~~~~~~
43
46
@@ -49,66 +52,10 @@ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthe
49
52
Code Overview
50
53
-------------
51
54
52
-
The ``src`` folder contains all our Django applications.
# Using your favorite editor, edit the code to make your change.
90
-
vim …
91
-
92
-
# Run your new tests
93
-
pytest ./path/to/new/tests
94
-
95
-
# Run all the tests and quality checks
96
-
make validate
97
-
98
-
# Commit all your changes
99
-
git commit …
100
-
git push
101
-
102
-
# Open a PR and ask for review.
103
-
104
-
Configuring Visual Studio Code
105
-
------------------------------
106
-
107
-
If you are using VS Code as your editor, you can enable the Testing bar by copying from the example configuration provided in the ``.vscode`` directory::
108
-
109
-
cd .vscode/
110
-
cp launch.json.example launch.json
111
-
cp settings.json.example settings.json
55
+
* ``./src/``: All published code. Packages are importable relative to this directory (e.g., ``import openedx_content``). See ``readme.rst`` in each sub-folder.
56
+
* ``./tests/``: Unit tests (not published).
57
+
* ``./test_utils/``: Internal helpers for unit tests (not published).
58
+
* ``./olx_importer/``: Internal utility for importing data for development (not published).
112
59
113
60
License
114
61
-------
@@ -140,26 +87,26 @@ For more information about these options, see the `Getting Help`_ page.
When this repo was created, it was intended to only encompass learning concepts. The content models were supposed to be read-optimized LMS-friendly representations of learning content. It was imagined that the authoring models would live elsewhere (e.g. Blockstore). That's why this was called "Learning Core".
8
+
9
+
Over time, we realized that we actually needed to start by developing write-optimized CMS-friendly models, many of which are ideal to be also be used in LMS. We ended up with an "Authoring API" which powered the Studio-only Content Libraries feature.
10
+
11
+
Now, we are working on CBE, Pathways, and Catalog-realted features in this repo. There's also still a Tagging API in this repo. So, the scope of Learning Core has increased, although it still makes sense to develop these important foundational, stable packages together in one core repository.
12
+
13
+
Decision
14
+
--------
15
+
16
+
The Learning Core is now the Open edX Core. The openedx-learning repository is now openedx-core, as is the installable PyPI project. It's a place to put foundational teaching and learning models and stable APIs. It is **not** a place to put code that is periphery, highly feature-specific, or lacking a path towards stability.
17
+
18
+
The Open edX Core will consist of several Django apps, each implementing a cohesive yet significant platform concern. Each app should expose a Python API (at ``.api``) and a models API (ideally at ``.models_api``), and optionally a REST API (at ``.rest_api``). We'll use importlinter to enforce boundaries between the apps. In the future, if we move to uv, we may manage these as `uv workspaces <https://docs.astral.sh/uv/concepts/projects/workspaces/>`_.
19
+
20
+
We will initially have two top-level Django applications:
21
+
22
+
* ``openedx_content``
23
+
* ``openedx_tagging``
24
+
25
+
We expect it to grow a few more top-level Django applications, including:
26
+
27
+
* ``openedx_learning`` (learner-facing models, similar to the original intent of Learning Core).
28
+
* ``openedx_catalog`` (CourseRun, etc.)
29
+
* ``openedx_cbe`` (Models related to pathways, credential-based education. Still in discussion).
30
+
31
+
Long term, we are open to more stable, core APIs moving in, such as:
32
+
33
+
* ``openedx_events``
34
+
* ``openedx_filters``
35
+
* ``openedx_authz``
36
+
* ``openedx_keys`` (renamed from ``opaque_keys``)
37
+
38
+
There are dependencies between these apps we'd want to keep in mind. For example, we wouldn't want to move in ``openedx_keys`` without moving in ``openedx_authz`` first, otherwise we'd create a cyclical dependency between ``openex-authz`` and ``openedx-core``.
39
+
40
+
By keeping each app as a top-level package and by using importlinter, we leave the door open for packages to be removed later. For example, if it becomes cumbersome to maintain ``openedx_catalog`` alongside the other core apps, then it should be possible to extract it into a separate ``openedx-catalog`` repo without breaking any external instances of ``from openedx_catalog import ...``.
41
+
42
+
Consequences
43
+
------------
44
+
45
+
We'll implement this change immediately as detailed in https://github.com/openedx/openedx-core/issues/470
46
+
47
+
Rejected alternatives
48
+
---------------------
49
+
50
+
* Separate repos for ``openedx-content``, ``openedx-cbe``, etc.
51
+
52
+
* Axim is making a conscious effort to slow the proliferation of new repos, as it has been challenging to maintain consistent standards, tooling, and upgrades across all of them. If there is not a strong reason to separate repos, then we would prefer to start off with a single repo.
53
+
54
+
* A combined top level Python package with nested apps: ``openedx_core.content.api``, ``openedx_core.cbe.api``, etc.
55
+
56
+
* This would make it harder to split apps out into separate repos later, because it would involve either (a) updating all the import statements or (b) having the ``openedx_core`` namespace split across multiple repos. We'd like to remain flexible with code reorganization given the fast-moving and experimental nature of these projects.
0 commit comments