build!: Switch to openedx-core (renamed from openedx-learning)#38011
build!: Switch to openedx-core (renamed from openedx-learning)#38011kdmccormick merged 5 commits intomasterfrom
Conversation
2be228a to
c207be1
Compare
c207be1 to
176512a
Compare
176512a to
e0550e6
Compare
e0550e6 to
e40615a
Compare
There was a problem hiding this comment.
Super nit: In quite a few places in this PR we have openedx-core-based which sounds like a package name. I think "based on openedx-core" (or something along those lines) is better, though it doesn't lend itself well to find-and-replace.
openedx/core/djangoapps/content_libraries/tests/test_runtime.py
Outdated
Show resolved
Hide resolved
bradenmacdonald
left a comment
There was a problem hiding this comment.
I renamed the folder, updated my mount points, rebuilt my openedx-dev image, and this seems to be working fine. I have those questions about how we're naming some of these things ^ but it's not blocking.
063495e to
5f9a65c
Compare
|
Thanks for the feedback. I'm a little torn on openedx-core vs. openedx_content. Neither name is very "catchy" and could easily be confused with existing parts of openedx-platform (like the Maybe it makes sense just to be precise. We can say openedx_content whenever we're talking just about the Content API, and say openedx-core whenever we're talking about the whole repo. After all, parts of openedx-core will end up being used for content from both ModuleStore and openedx_content... Pathways (from openedx-core) will contain CourseRuns (whose content is in ModuleStore). Any block can have tags from openedx_tagging. etc. I pushed a separate commit which does that. Let me know what you think @bradenmacdonald . |
|
|
||
|
|
||
| class LearningCoreXBlockRuntime(XBlockRuntime): | ||
| class OpenedXContentRuntime(XBlockRuntime): |
There was a problem hiding this comment.
@bradenmacdonald tangential question: what purpose is the XBlockRuntime class serving? could it be merged into OpenedXContentRuntime?
There was a problem hiding this comment.
I guess I was hoping that we'd implement a ModulestoreRuntime which derives from XBlockRuntime for more consistency in our runtimes, but nothing has panned out. I think it would be fine to merge them together.
|
@kdmccormick Thanks for those changes. I'm a little torn as well, but I think your changes and general approach makes sense. ✅ |
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: * By default, we use the term "openedx-core" everywhere. * We use "Open edX Core" occasionally to look nice external-facing documentation. * In snake-case code, it's `*_openedx_core_*`. * In camel-case code, it's `*OpenedXCore*` For consistency's sake we avoid any variant of oex_core, OeXCore OexCore, Open-edX-Core, OpenEdxCore, etc. There should be no more occurances of learning_core, learning-core, Learning Core, Learning-Core, 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: openedx/openedx-core#470
…riate openedx-core is the repo and PyPI project name. openedx_content is the concrete code API within openedx-core which the new XBlock runtime uses.
5f9a65c to
e10c49d
Compare
|
thanks @bradenmacdonald ! fyi I pushed a couple more trivial comment updates that I just found: 5099a35 . I'll merge once tests pass unless you have any objection. |
Description
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:
which is actually the thing we have been calling "Learning Core" all along.
*_openedx_content_*.*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.
Testing
I smoke tested libraries and django admin on my own
tutor dev, confirmed that bind-mounting works with the new repo. Will do the same smoke tests on the PR sandbox.Supporting info
ADR: https://github.com/openedx/openedx-core/blob/main/docs/decisions/0021-openedx-core.rst
Part of: openedx/openedx-core#470
Follows up from openedx/openedx-core#471
Merge deadline
This week, ideally, so we don't exist in confusing semi-renamed state for long