docs: merge upstream/main into cbe_assessment_criteria_versioning_adr

Author: mgwozdz-unicon

.coveragerc

@@ -2,8 +2,7 @@
 branch = True
 data_file = .coverage
 source =
-	openedx_learning
-	openedx_tagging
+    src
 omit =
     test_settings
     **/migrations/*

.github/workflows/ci.yml

@@ -16,12 +16,8 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]  # Add macos-latest later?
-        python-version: ['3.11', '3.12']
-        toxenv: ["django42", "django52", "package", "quality"]
-        # We're only testing against MySQL 8 right now because 5.7 is
-        # incompatible with Djagno 4.2. We'd have to make the tox.ini file more
-        # complicated than it's worth given the short expected shelf-life of
-        # MySQL 5.7 in our stack.
+        python-version: ['3.12']
+        toxenv: ["django52", "package", "quality"]
         mysql-version: ["8"]
     services:
       mysql:

.github/workflows/lint-imports.yml

@@ -17,13 +17,13 @@ jobs:
       - name: setup python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install pip
         run: pip install -r requirements/pip.txt
 
       - name: Install Dependencies
-        run: pip install -r requirements/ci.txt
+        run: pip install -e . -r requirements/quality.txt
 
       - name: Analyze imports
         run: lint-imports

.github/workflows/pypi-publish.yml

@@ -15,15 +15,15 @@ jobs:
       - name: setup python
         uses: actions/setup-python@v6
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install pip
         run: pip install -r requirements/pip.txt
 
-      - name: Build package
+      - name: Build the package (openedx-core)
         run: python setup.py sdist bdist_wheel
 
-      - name: Publish to PyPI
+      - name: Publish openedx-core to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__

.gitignore

@@ -54,8 +54,8 @@ output/*/index.html
 # Sphinx
 docs/_build
 docs/modules.rst
-docs/openedx_learning.rst
-docs/openedx_learning.*.rst
+docs/openedx_content.rst
+docs/openedx_content.*.rst
 
 # Private requirements
 requirements/private.in
@@ -66,6 +66,7 @@ dev.db*
 
 # virtualenv
 venv/
+.venv/
 
 ### Visual Studio Code ###
 # Generally ignore VS Code configuration, except... 

.importlinter

@@ -1,59 +1,66 @@
-# openedx_learning is intended to be a library of apps used across multiple
+# This repo is intended to be a library of apps used across multiple
 # projects, and we want to ensure certain dependency relationships. Please
 # think through any changes you make to this file carefully, and don't just
 # casually modify these linting rules to "fix the build".
+
 [importlinter]
-root_package = openedx_learning
-
-# This is the most basic layering for openedx_learning.
-#
-# The "lib" package is meant for low level utilities, field definitions, and the
-# like, so it's at the bottom layer.
-#
-# The "core" apps are meant to be the heart of our system, with foundational
-# data models and plugin interfaces. It can rely on "lib" utilities.
-#
-# The "contrib" apps are meant to be apps that could easily be created outside
-# of openedx_learning in a separate repository, but are bundled here because
-# we think they'll be generally useful. These apps may call into "core" or "lib"
-# apps, but not the other way around. The "core" apps should *never* import from
-# "contrib".
-[importlinter:contract:openedx_learning_layering]
-name = Lib / Core / Contrib Layering
+root_packages =
+    openedx_content
+    openedx_tagging
+    openedx_django_lib
+    openedx_core
+
+# This is layering between our top-level src folders (mostly Django apps).
+# This should be updated as new Django apps are added.
+# It's possible this might need to grow into multiple rules.
+[importlinter:contract:src_layering]
+name = "top-level source folders are layered correctly"
 type = layers
-layers=
-    openedx_learning.contrib
-    openedx_learning.apps
-    openedx_learning.lib
-
-# This is layering within our Authoring apps. Every new app should be added to
-# this list when it it created.
-[importlinter:contract:core_apps_layering]
-name = Authoring App Dependency Layering
+layers =
+    # Content is currently the highest-level thing in this repo.
+    # Over time, we may add apps "above" or "below" this.
+    openedx_content
+
+    # Tagging is very simple & fundamental. Should probably not depend on any other Django apps.
+    openedx_tagging
+
+    # Django utilities. Should not dependend on any of the real apps (above).
+    openedx_django_lib
+
+    # This just an empty shell package, to expose the __version__ number.
+    # Should not depend on anything.
+    openedx_core
+
+# This is "applet" layering, within our Content djangoapp.
+# Every new applet should be added to  this list when it it created.
+[importlinter:contract:content_applet_layering]
+name = "openedx_content's internal applets are layered correctly"
 type = layers
 layers=
-    # The public authoring API is at the top–none of the apps should call to it.
-    openedx_learning.api.authoring
+    # The public API is at the top. None of the internal applets should call to it.
+    openedx_content.api
 
-    # The "backup_restore" app handle the new export and import mechanism.
-    openedx_learning.apps.openedx_content.applets.backup_restore
+    # The "backup_restore" applet handles the new export and import mechanism.
+    openedx_content.applets.backup_restore
 
-    # The "components" app is responsible for storing versioned Components,
-    # which is Open edX Studio terminology maps to things like individual
+    # The "components" applet is responsible for storing versioned Components,
+    # which in Open edX Studio terminology maps to things like individual
     # Problems, Videos, and blocks of HTML text. This is also the type we would
     # associate with a single "leaf" XBlock–one that is not a container type and
     # has no child elements.
-    openedx_learning.apps.openedx_content.applets.components
+    # The "containers" app is built on top of publishing, and is a peer to
+    # "components" but they do not depend on each other.
+    openedx_content.applets.components | openedx_content.applets.containers
 
-    # The "contents" app stores the simplest pieces of binary and text data,
+    # The "media" applet stores the simplest pieces of binary and text data,
     # without versioning information. These belong to a single Learning Package.
-    openedx_learning.apps.openedx_content.applets.contents
+    openedx_content.applets.media
 
-    # The "collections" app stores arbitrary groupings of PublishableEntities.
+    # The "collections" applet stores arbitrary groupings of PublishableEntities.
     # Its only dependency should be the publishing app.
-    openedx_learning.apps.openedx_content.applets.collections
+    openedx_content.applets.collections
 
     # The lowest layer is "publishing", which holds the basic primitives needed
     # to create Learning Packages and manage the draft and publish states for
     # various types of content.
-    openedx_learning.apps.openedx_content.applets.publishing
+    openedx_content.applets.publishing

.readthedocs.yaml

@@ -10,6 +10,6 @@ sphinx:
   configuration: docs/conf.py
 
 python:
-  version: 3.11
+  version: 3.12
   install:
     - requirements: requirements/doc.txt

CHANGELOG.rst

@@ -2,5 +2,4 @@ include CHANGELOG.rst
 include LICENSE.txt
 include README.rst
 include requirements/base.in
-recursive-include openedx_learning *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py
-recursive-include openedx_tagging *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py *.yaml *.json *.csv
+recursive-include src *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.py *.yaml *.json *.csv

MANIFEST.in

@@ -80,21 +80,19 @@ selfcheck: ## check that the Makefile is well-formed
 	@echo "The Makefile is well-formed."
 
 ## Localization targets
+# TODO: Need to audit these, and then actually tell openedx-translations
+# to use them. https://github.com/openedx/openedx-core/issues/483
 
 extract_translations: ## extract strings to be translated, outputting .mo files
 	rm -rf docs/_build
-	cd openedx_learning && ../manage.py makemessages -l en -v1 -d django
-	cd openedx_learning && ../manage.py makemessages -l en -v1 -d djangojs
-	cd openedx_tagging && ../manage.py makemessages -l en -v1 -d django
-	cd openedx_tagging && ../manage.py makemessages -l en -v1 -d djangojs
+	./manage.py makemessages -l en -v1 -d django
+	./manage.py makemessages -l en -v1 -d djangojs
 
 compile_translations: ## compile translation files, outputting .po files for each supported language
-	cd openedx_learning && ../manage.py compilemessages
-	cd openedx_tagging && ../manage.py compilemessages
+	./manage.py compilemessages
 
 detect_changed_source_translations:
-	cd openedx_learning && i18n_tool changed
-	cd openedx_tagging && i18n_tool changed
+	cd src && i18n_tool changed
 
 pull_translations: ## pull translations from Transifex
 	tx pull -a -f -t --mode reviewed
@@ -103,8 +101,7 @@ push_translations: ## push source translation files (.po) from Transifex
 	tx push -s
 
 dummy_translations: ## generate dummy translation (.po) files
-	cd openedx_learning && i18n_tool dummy
-	cd openedx_tagging && i18n_tool dummy
+	cd src && i18n_tool dummy
 
 build_dummy_translations: extract_translations dummy_translations compile_translations ## generate and compile dummy translation files