build!: Rename the PyPI project to openedx-core

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 going forward.

Part of: #470

Author: kdmccormick

.github/workflows/pypi-publish.yml

@@ -20,11 +20,28 @@ jobs:
       - 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__
           password: ${{ secrets.PYPI_UPLOAD_TOKEN }}
+
+      # TEMPORARY: Build and publish the transitional openedx-learning shell package.
+      # TODO: Remove after the transition is complete.
+      # See https://github.com/openedx/openedx-learning/issues/470
+
+      - name: Build shell package (openedx-learning)
+        run: |
+          cd tmp-openedx-learning
+          python setup.py sdist bdist_wheel
+          cd ..
+
+      - name: Publish openedx-learning shell to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_UPLOAD_TOKEN }}
+          packages-dir: tmp-openedx-learning/dist/

CHANGELOG.rst

@@ -81,7 +81,7 @@ selfcheck: ## check that 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-learning/issues/483
+# 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

Makefile

@@ -1,28 +1,32 @@
-Open edX Learning Core (and Tagging)
-====================================
+Open edX Core: Foundational Packages for a Teaching & Learning Platform
+=======================================================================
 
 |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
 |license-badge|
 
 Overview
 --------
 
-The ``openedx-learning`` project holds Django apps that represent core learning platform concepts.
+*Formerly known as "Learning Core" or "openedx-learning".*
+
+The ``openedx-core`` project holds Django apps which represent core teaching & learning platform concepts.
+
+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.
 
 Motivation
 ----------
 
-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.
+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.
 
-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.
+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.
 
 Architecture
 ------------
 
-Learning Core Package Dependencies
+Open edX Core Package Dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Learning Core code should never import from ``openedx-platform``.
+Open edX Core code should never import from ``openedx-platform``.
 
 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.
 
@@ -37,7 +41,6 @@ We have a few different identifier types in the schema, and we try to avoid ``_i
 * ``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``.
 * ``num`` is like ``key``, but for use when it's strictly numeric. It can also be used as a suffix.
 
-
 See Also
 ~~~~~~~~
 
@@ -49,66 +52,10 @@ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthe
 Code Overview
 -------------
 
-The ``src`` folder contains all our Django applications.
-
-Development Workflow
---------------------
-
-One Time Setup
-~~~~~~~~~~~~~~
-.. code-block::
-
-  # Clone the repository
-  git clone git@github.com:ormsbee/openedx-learning.git
-  cd openedx-learning
-
-  # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
-  mkvirtualenv -p python3.11 openedx-learning
-
-
-Every time you develop something in this repo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. code-block::
-
-  # Activate the virtualenv
-  workon openedx-learning
-
-  # Grab the latest code
-  git checkout master
-  git pull
-
-  # Install/update the dev requirements
-  make requirements
-
-  # Run the tests and quality checks (to verify the status before you make any changes)
-  make validate
-
-  # Make a new branch for your changes
-  git checkout -b <your_github_username>/<short_description>
-
-  # Using your favorite editor, edit the code to make your change.
-  vim …
-
-  # Run your new tests
-  pytest ./path/to/new/tests
-
-  # Run all the tests and quality checks
-  make validate
-
-  # Commit all your changes
-  git commit …
-  git push
-
-  # Open a PR and ask for review.
-
-Configuring Visual Studio Code
-------------------------------
-
-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::
-
-    cd .vscode/
-    cp launch.json.example launch.json
-    cp settings.json.example settings.json
+* ``./src/``: All published code. Packages are importable relative to this directory (e.g., ``import openedx_content``). See ``readme.rst`` in each sub-folder.
+* ``./tests/``: Unit tests (not published).
+* ``./test_utils/``: Internal helpers for unit tests (not published).
+* ``./olx_importer/``: Internal utility for importing data for development (not published).
 
 License
 -------
@@ -140,26 +87,26 @@ For more information about these options, see the `Getting Help`_ page.
 .. _community Slack workspace: https://openedx.slack.com/
 .. _Getting Help: https://openedx.org/getting-help
 
-.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-learning.svg
-    :target: https://pypi.python.org/pypi/openedx-learning/
+.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-core.svg
+    :target: https://pypi.python.org/pypi/openedx-core/
     :alt: PyPI
 
-.. |ci-badge| image:: https://github.com/openedx/openedx-learning/workflows/Python%20CI/badge.svg?branch=master
-    :target: https://github.com/openedx/openedx-learning/actions
+.. |ci-badge| image:: https://github.com/openedx/openedx-core/workflows/Python%20CI/badge.svg?branch=master
+    :target: https://github.com/openedx/openedx-core/actions
     :alt: CI
 
-.. |codecov-badge| image:: https://codecov.io/github/edx/openedx-learning/coverage.svg?branch=master
-    :target: https://codecov.io/github/edx/openedx-learning?branch=master
+.. |codecov-badge| image:: https://codecov.io/github/edx/openedx-core/coverage.svg?branch=master
+    :target: https://codecov.io/github/edx/openedx-core?branch=master
     :alt: Codecov
 
-.. |doc-badge| image:: https://readthedocs.org/projects/openedx-learning/badge/?version=latest
-    :target: https://openedx-learning.readthedocs.io/en/latest/
+.. |doc-badge| image:: https://readthedocs.org/projects/openedx-core/badge/?version=latest
+    :target: https://openedx-core.readthedocs.io/en/latest/
     :alt: Documentation
 
-.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-learning.svg
-    :target: https://pypi.python.org/pypi/openedx-learning/
+.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-core.svg
+    :target: https://pypi.python.org/pypi/openedx-core/
     :alt: Supported Python versions
 
-.. |license-badge| image:: https://img.shields.io/github/license/edx/openedx-learning.svg
-    :target: https://github.com/openedx/openedx-learning/blob/master/LICENSE.txt
+.. |license-badge| image:: https://img.shields.io/github/license/edx/openedx-core.svg
+    :target: https://github.com/openedx/openedx-core/blob/master/LICENSE.txt
     :alt: License

README.rst

@@ -1,7 +1,7 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: openedx-learning
+  name: openedx-core
 spec:
   type: other
   lifecycle: unknown

catalog-info.yaml

@@ -96,9 +96,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openedx-learning.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openedx-core.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openedx-learning.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openedx-core.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -115,8 +115,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/openedx-learning"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openedx-learning"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/openedx-core"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openedx-core"
 	@echo "# devhelp"
 
 .PHONY: epub

docs/Makefile

@@ -1,6 +1,6 @@
 # pylint: disable=invalid-name
 """
-openedx-learning documentation build configuration file.
+openedx-core documentation build configuration file.
 
 This file is execfile()d with the current directory set to its
 containing dir.
@@ -89,10 +89,10 @@ def get_version(*file_paths):
 top_level_doc = 'index'
 
 # General information about the project.
-project = 'openedx-learning'
-copyright = f'{datetime.now().year}, edX Inc.' # pylint: disable=redefined-builtin
-author = 'edX Inc.'
-project_title = 'Open edX Learning Core'
+project = 'openedx-core'
+copyright = f'{datetime.now().year}, Axim Collaborative, Inc.' # pylint: disable=redefined-builtin
+author = 'Axim Collaborative, Inc.'
+project_title = 'Open edX Core'
 documentation_title = f"{project_title}"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -169,7 +169,7 @@ def get_version(*file_paths):
 # documentation.
 #
 html_theme_options = {
- "repository_url": "https://github.com/openedx/openedx-learning",
+ "repository_url": "https://github.com/openedx/openedx-core",
  "repository_branch": "main",
  "path_to_docs": "docs/",
  "home_page_in_toc": True,
@@ -206,7 +206,7 @@ def get_version(*file_paths):
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = 'openedx-learning v0.1.0'
+# html_title = 'openedx-core v0.1.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #

docs/conf.py

@@ -12,7 +12,7 @@ The code that operates on learning content in Open edX primarily resides in edx-
 Decision
 --------
 
-The openedx-learning repository was created to provide a new place for certain core learning concepts, data models, and APIs to be implemented. These concepts will be more granular and composable than the courses we have today.
+The openedx-core repository was created to provide a new place for certain core learning concepts, data models, and APIs to be implemented. These concepts will be more granular and composable than the courses we have today.
 
 This would have two long term goals:
 
@@ -24,7 +24,7 @@ This repo will first be piloted with the use case of unit composition in service
 Consequences
 ------------
 
-The edx-platform repo will eventually have openedx-learning as a dependency. As functionality is implemented in openedx-learning (e.g. unit composition for content libraries), edx-platform will make use of it.
+The edx-platform repo will eventually have openedx-core as a dependency. As functionality is implemented in openedx-core (e.g. unit composition for content libraries), edx-platform will make use of it.
 
 Over time, plugin apps should be able to make use of stable APIs in this repo instead of having to call into edx-platform's Modulestore or Block Transformers. This will serve as a third leg of the new in-process extension mechanisms, where openedx-events provides event notification, openedx-filters provides the ability to intercept and modify the workflow of existing views, and this repo will allow content querying capability.
 

docs/decisions/0001-purpose-of-this-repo.rst

@@ -35,7 +35,7 @@ Learning Core data models will be built with extensibility in mind, with the fol
 #. It will be possible to migrate existing content data over time, as new plugin apps become available.
 #. All content and versions of content will have UUIDs to allow for stable references across services.
 
-This layering of related models will add complexity to the data model, but we accept that tradeoff to decouple plugin models from the core application and from other plugins. To make this easier to deal with, openedx-learning should provide abstract models for common use cases, and expose those via a ``models_api.py`` module. This will lower the barrier to entry for developers, and allow us to more easily enforce conventions like setting ``primary_key=True`` with our ``OneToOneField`` relationships.
+This layering of related models will add complexity to the data model, but we accept that tradeoff to decouple plugin models from the core application and from other plugins. To make this easier to deal with, openedx-core should provide abstract models for common use cases, and expose those via a ``models_api.py`` module. This will lower the barrier to entry for developers, and allow us to more easily enforce conventions like setting ``primary_key=True`` with our ``OneToOneField`` relationships.
 
 Rejected Alternatives
 ---------------------

docs/decisions/0003-content-extensibility.rst

@@ -4,7 +4,7 @@
 Context
 -------
 
-We want the openedx_tagging app to be useful in different Django projects outside of just openedx-learning and edx-platform.
+We want the openedx_tagging app to be useful in different Django projects outside of just openedx-core and edx-platform.
 
 
 Decisions