openedx-learning 0.9.4__tar.gz → 0.10.0__tar.gz

{openedx_learning-0.9.4/openedx_learning.egg-info → openedx_learning-0.10.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.9.4
-Summary: An experiment.
+Version: 0.10.0
+Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
 Author-email: dave@tcril.org
@@ -19,26 +19,23 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 License-File: LICENSE.txt
-Requires-Dist: edx-drf-extensions
 Requires-Dist: rules<4.0
-Requires-Dist: celery
 Requires-Dist: Django<5.0
+Requires-Dist: edx-drf-extensions
 Requires-Dist: attrs
+Requires-Dist: celery
 Requires-Dist: djangorestframework<4.0
 
-openedx-learning
-=============================
+Open edX Learning Core (and Tagging)
+====================================
 
 |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
 |license-badge|
 
-This is experimentation/prototyping and not in any way production ready!
-------------------------------------------------------------------------
-
 Overview
 --------
 
-The Open edX Learning repository holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform.
+The ``openedx_learning`` package holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform. At the moment, this repo also contains the ``openedx_tagging`` package, but this will likely be moved out in the future.
 
 Motivation
 ----------
@@ -54,18 +51,16 @@ Parts
 ~~~~~
 
 * ``openedx_learning.lib`` is for shared utilities, and may include things like custom field types, plugin registration code, etc.
-* ``openedx_learning.core`` contains our Core Django apps, where foundational data structures and APIs will live.
+* ``openedx_learning.apps`` contains our Learning Core Django apps, where foundational data structures and APIs will live. The first of these is ``authoring``, which holds apps related to the editing and publishing of learning content.
 * ``openedx_tagging.core`` contains the core Tagging app, which provides data structures and apis for tagging Open edX objects.
 
-App Dependencies
-~~~~~~~~~~~~~~~~
+Learning Core Package Dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Anything can import from ``openedx_learning.lib``.
+Learning Core code should never import from ``edx-platform``.
 
-Core apps can import from each other, but cannot import from other apps outside of core. For those apps:
+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.
 
-* ``learning_publishing`` has no dependencies. All the other apps depend on it.
-* ``learning_composition`` and ``learning_navigation`` both depend on ``learning_partitioning``
 
 Model Conventions
 ~~~~~~~~~~~~~~~~~
@@ -74,7 +69,7 @@ We have a few different identifier types in the schema, and we try to avoid ``_i
 
 * ``id`` is the auto-generated, internal row ID and primary key. This never changes. Data models should make foreign keys to this field, as per Django convention.
 * ``uuid`` is a randomly generated UUID4. This is the stable way to refer to a row/resource from an external service. This never changes. This is separate from ``id`` mostly because there are performance penalties when using UUIDs as primary keys with MySQL.
-* ``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.
+* ``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.
 
 
@@ -89,7 +84,7 @@ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthe
 Code Overview
 -------------
 
-The ``openedx_learning.apps`` package contains all our Django applications. All apps are named with a ``learning_`` prefix to better avoid name conflicts, because Django's app namespace is flat. Apps will adhere to `OEP-0049: Django App Patterns <https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0049-django-app-patterns.html>`_.
+The ``openedx_learning.apps`` package contains all our Django applications.
 
 Development Workflow
 --------------------
@@ -103,7 +98,7 @@ One Time Setup
   cd openedx-learning
 
   # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
-  mkvirtualenv -p python3.8 openedx-learning
+  mkvirtualenv -p python3.11 openedx-learning
 
 
 Every time you develop something in this repo

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/README.rst

@@ -1,16 +1,13 @@
-openedx-learning
-=============================
+Open edX Learning Core (and Tagging)
+====================================
 
 |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
 |license-badge|
 
-This is experimentation/prototyping and not in any way production ready!
-------------------------------------------------------------------------
-
 Overview
 --------
 
-The Open edX Learning repository holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform.
+The ``openedx_learning`` package holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform. At the moment, this repo also contains the ``openedx_tagging`` package, but this will likely be moved out in the future.
 
 Motivation
 ----------
@@ -26,18 +23,16 @@ Parts
 ~~~~~
 
 * ``openedx_learning.lib`` is for shared utilities, and may include things like custom field types, plugin registration code, etc.
-* ``openedx_learning.core`` contains our Core Django apps, where foundational data structures and APIs will live.
+* ``openedx_learning.apps`` contains our Learning Core Django apps, where foundational data structures and APIs will live. The first of these is ``authoring``, which holds apps related to the editing and publishing of learning content.
 * ``openedx_tagging.core`` contains the core Tagging app, which provides data structures and apis for tagging Open edX objects.
 
-App Dependencies
-~~~~~~~~~~~~~~~~
+Learning Core Package Dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Anything can import from ``openedx_learning.lib``.
+Learning Core code should never import from ``edx-platform``.
 
-Core apps can import from each other, but cannot import from other apps outside of core. For those apps:
+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.
 
-* ``learning_publishing`` has no dependencies. All the other apps depend on it.
-* ``learning_composition`` and ``learning_navigation`` both depend on ``learning_partitioning``
 
 Model Conventions
 ~~~~~~~~~~~~~~~~~
@@ -46,7 +41,7 @@ We have a few different identifier types in the schema, and we try to avoid ``_i
 
 * ``id`` is the auto-generated, internal row ID and primary key. This never changes. Data models should make foreign keys to this field, as per Django convention.
 * ``uuid`` is a randomly generated UUID4. This is the stable way to refer to a row/resource from an external service. This never changes. This is separate from ``id`` mostly because there are performance penalties when using UUIDs as primary keys with MySQL.
-* ``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.
+* ``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.
 
 
@@ -61,7 +56,7 @@ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthe
 Code Overview
 -------------
 
-The ``openedx_learning.apps`` package contains all our Django applications. All apps are named with a ``learning_`` prefix to better avoid name conflicts, because Django's app namespace is flat. Apps will adhere to `OEP-0049: Django App Patterns <https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0049-django-app-patterns.html>`_.
+The ``openedx_learning.apps`` package contains all our Django applications.
 
 Development Workflow
 --------------------
@@ -75,7 +70,7 @@ One Time Setup
   cd openedx-learning
 
   # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
-  mkvirtualenv -p python3.8 openedx-learning
+  mkvirtualenv -p python3.11 openedx-learning
 
 
 Every time you develop something in this repo

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/openedx_learning/__init__.py

@@ -1,4 +1,4 @@
 """
 Open edX Learning ("Learning Core").
 """
-__version__ = "0.9.4"
+__version__ = "0.10.0"

openedx_learning-0.10.0/openedx_learning/api/authoring.py

@@ -0,0 +1,14 @@
+"""
+This is the public API for content authoring in Learning Core.
+
+This is the single ``api`` module that code outside of the
+``openedx_learning.apps.authoring.*`` package should import from. It will
+re-export the public functions from all api.py modules of all authoring apps. It
+may also implement its own convenience APIs that wrap calls to multiple app
+APIs.
+"""
+# These wildcard imports are okay because these api modules declare __all__.
+# pylint: disable=wildcard-import
+from ..apps.authoring.components.api import *
+from ..apps.authoring.contents.api import *
+from ..apps.authoring.publishing.api import *

openedx_learning-0.10.0/openedx_learning/api/authoring_models.py

@@ -0,0 +1,13 @@
+"""
+This is where we expose a small handful of models and model mixins that we want
+callers to extend or make foreign keys to. Callers importing this module should
+never instantiate any of the models themselves–there are API functions in
+authoring.py to create and modify data models in a way that keeps those models
+consistent.
+"""
+# These wildcard imports are okay because these modules declare __all__.
+# pylint: disable=wildcard-import
+from ..apps.authoring.components.models import *
+from ..apps.authoring.contents.models import *
+from ..apps.authoring.publishing.model_mixins import *
+from ..apps.authoring.publishing.models import *

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/components/api.py

@@ -21,6 +21,24 @@ from django.db.transaction import atomic
 from ..publishing import api as publishing_api
 from .models import Component, ComponentType, ComponentVersion, ComponentVersionContent
 
+# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# is listed in the __all__ entries below. Internal helper functions that are
+# private to this module should start with an underscore. If a function does not
+# start with an underscore AND it is not in __all__, that function is considered
+# to be callable only by other apps in the authoring package.
+__all__ = [
+    "get_or_create_component_type",
+    "create_component",
+    "create_component_version",
+    "create_next_version",
+    "create_component_and_version",
+    "get_component",
+    "get_component_by_key",
+    "component_exists_by_key",
+    "get_components",
+    "create_component_version_content",
+]
+
 
 def get_or_create_component_type(namespace: str, name: str) -> ComponentType:
     """
@@ -308,6 +326,9 @@ def look_up_component_version_content(
 
     Can raise a django.core.exceptions.ObjectDoesNotExist error if there is no
     matching ComponentVersionContent.
+
+    This API call was only used in our proof-of-concept assets media server, and
+    I don't know if we wantto make it a part of the public interface.
     """
     queries = (
         Q(component_version__component__learning_package__key=learning_package_key)

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/components/apps.py

@@ -9,8 +9,8 @@ class ComponentsConfig(AppConfig):
     Configuration for the Components Django application.
     """
 
-    name = "openedx_learning.core.components"
-    verbose_name = "Learning Core: Components"
+    name = "openedx_learning.apps.authoring.components"
+    verbose_name = "Learning Core > Authoring > Components"
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_components"
 

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/components/models.py

@@ -19,12 +19,19 @@ from __future__ import annotations
 
 from django.db import models
 
-from ...lib.fields import case_sensitive_char_field, immutable_uuid_field, key_field
-from ...lib.managers import WithRelationsManager
+from ....lib.fields import case_sensitive_char_field, immutable_uuid_field, key_field
+from ....lib.managers import WithRelationsManager
 from ..contents.models import Content
 from ..publishing.model_mixins import PublishableEntityMixin, PublishableEntityVersionMixin
 from ..publishing.models import LearningPackage
 
+__all__ = [
+    "ComponentType",
+    "Component",
+    "ComponentVersion",
+    "ComponentVersionContent",
+]
+
 
 class ComponentType(models.Model):
     """

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/contents/api.py

@@ -11,9 +11,21 @@ from datetime import datetime
 from django.core.files.base import ContentFile
 from django.db.transaction import atomic
 
-from ...lib.fields import create_hash_digest
+from ....lib.fields import create_hash_digest
 from .models import Content, MediaType
 
+# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# is listed in the __all__ entries below. Internal helper functions that are
+# private to this module should start with an underscore. If a function does not
+# start with an underscore AND it is not in __all__, that function is considered
+# to be callable only by other apps in the authoring package.
+__all__ = [
+    "get_or_create_media_type",
+    "get_content",
+    "get_or_create_text_content",
+    "get_or_create_file_content",
+]
+
 
 def get_or_create_media_type(mime_type: str) -> MediaType:
     """

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/contents/apps.py

@@ -9,7 +9,7 @@ class ContentsConfig(AppConfig):
     Configuration for the Contents Django application.
     """
 
-    name = "openedx_learning.core.contents"
-    verbose_name = "Learning Core: Contents"
+    name = "openedx_learning.apps.authoring.contents"
+    verbose_name = "Learning Core > Authoring > Contents"
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_contents"

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/contents/models.py

@@ -13,10 +13,15 @@ from django.core.files.storage import Storage, default_storage
 from django.core.validators import MaxValueValidator
 from django.db import models
 
-from ...lib.fields import MultiCollationTextField, case_insensitive_char_field, hash_field, manual_date_time_field
-from ...lib.managers import WithRelationsManager
+from ....lib.fields import MultiCollationTextField, case_insensitive_char_field, hash_field, manual_date_time_field
+from ....lib.managers import WithRelationsManager
 from ..publishing.models import LearningPackage
 
+__all__ = [
+    "MediaType",
+    "Content",
+]
+
 
 def get_storage() -> Storage:
     """

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/publishing/api.py

@@ -23,6 +23,34 @@ from .models import (
     PublishLogRecord,
 )
 
+# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# is listed in the __all__ entries below. Internal helper functions that are
+# private to this module should start with an underscore. If a function does not
+# start with an underscore AND it is not in __all__, that function is considered
+# to be callable only by other apps in the authoring package.
+__all__ = [
+    "get_learning_package",
+    "get_learning_package_by_key",
+    "create_learning_package",
+    "update_learning_package",
+    "learning_package_exists",
+    "create_publishable_entity",
+    "create_publishable_entity_version",
+    "get_publishable_entity",
+    "get_publishable_entity_by_key",
+    "get_last_publish",
+    "get_all_drafts",
+    "get_entities_with_unpublished_changes",
+    "get_entities_with_unpublished_deletes",
+    "publish_all_drafts",
+    "get_draft_version",
+    "get_published_version",
+    "set_draft_version",
+    "soft_delete_draft",
+    "reset_drafts_to_published",
+    "register_content_models",
+]
+
 
 def get_learning_package(learning_package_id: int, /) -> LearningPackage:
     """
@@ -105,6 +133,13 @@ def update_learning_package(
     return lp
 
 
+def learning_package_exists(key: str) -> bool:
+    """
+    Check whether a LearningPackage with a particular key exists.
+    """
+    return LearningPackage.objects.filter(key=key).exists()
+
+
 def create_publishable_entity(
     learning_package_id: int,
     /,
@@ -167,13 +202,6 @@ def get_publishable_entity_by_key(learning_package_id, /, key) -> PublishableEnt
     )
 
 
-def learning_package_exists(key: str) -> bool:
-    """
-    Check whether a LearningPackage with a particular key exists.
-    """
-    return LearningPackage.objects.filter(key=key).exists()
-
-
 def get_last_publish(learning_package_id: int, /) -> PublishLog | None:
     return PublishLog.objects \
                      .filter(learning_package_id=learning_package_id) \

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/publishing/apps.py

@@ -10,7 +10,7 @@ class PublishingConfig(AppConfig):
     Configuration for the publishing Django application.
     """
 
-    name = "openedx_learning.core.publishing"
-    verbose_name = "Learning Core: Publishing"
+    name = "openedx_learning.apps.authoring.publishing"
+    verbose_name = "Learning Core > Authoring > Publishing"
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_publishing"

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/publishing/model_mixins.py

@@ -11,6 +11,12 @@ from django.db.models.query import QuerySet
 
 from .models import PublishableEntity, PublishableEntityVersion
 
+__all__ = [
+    "PublishableEntityMixin",
+    "PublishableEntityVersionMixin",
+    "PublishableContentModelRegistry",
+]
+
 
 class PublishableEntityMixin(models.Model):
     """

{openedx_learning-0.9.4/openedx_learning/core → openedx_learning-0.10.0/openedx_learning/apps/authoring}/publishing/models.py

@@ -23,6 +23,16 @@ from openedx_learning.lib.fields import (
     manual_date_time_field,
 )
 
+__all__ = [
+    "LearningPackage",
+    "PublishableEntity",
+    "PublishableEntityVersion",
+    "Draft",
+    "PublishLog",
+    "PublishLogRecord",
+    "Published",
+]
+
 
 class LearningPackage(models.Model):  # type: ignore[django-manager-missing]
     """

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/openedx_learning/contrib/media_server/views.py

@@ -8,7 +8,7 @@ from pathlib import Path
 from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
 from django.http import FileResponse, Http404
 
-from openedx_learning.core.components.api import look_up_component_version_content
+from openedx_learning.apps.authoring.components.api import look_up_component_version_content
 
 
 def component_asset(

{openedx_learning-0.9.4 → openedx_learning-0.10.0/openedx_learning.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.9.4
-Summary: An experiment.
+Version: 0.10.0
+Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
 Author-email: dave@tcril.org
@@ -19,26 +19,23 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 License-File: LICENSE.txt
-Requires-Dist: edx-drf-extensions
 Requires-Dist: rules<4.0
-Requires-Dist: celery
 Requires-Dist: Django<5.0
+Requires-Dist: edx-drf-extensions
 Requires-Dist: attrs
+Requires-Dist: celery
 Requires-Dist: djangorestframework<4.0
 
-openedx-learning
-=============================
+Open edX Learning Core (and Tagging)
+====================================
 
 |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
 |license-badge|
 
-This is experimentation/prototyping and not in any way production ready!
-------------------------------------------------------------------------
-
 Overview
 --------
 
-The Open edX Learning repository holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform.
+The ``openedx_learning`` package holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform. At the moment, this repo also contains the ``openedx_tagging`` package, but this will likely be moved out in the future.
 
 Motivation
 ----------
@@ -54,18 +51,16 @@ Parts
 ~~~~~
 
 * ``openedx_learning.lib`` is for shared utilities, and may include things like custom field types, plugin registration code, etc.
-* ``openedx_learning.core`` contains our Core Django apps, where foundational data structures and APIs will live.
+* ``openedx_learning.apps`` contains our Learning Core Django apps, where foundational data structures and APIs will live. The first of these is ``authoring``, which holds apps related to the editing and publishing of learning content.
 * ``openedx_tagging.core`` contains the core Tagging app, which provides data structures and apis for tagging Open edX objects.
 
-App Dependencies
-~~~~~~~~~~~~~~~~
+Learning Core Package Dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Anything can import from ``openedx_learning.lib``.
+Learning Core code should never import from ``edx-platform``.
 
-Core apps can import from each other, but cannot import from other apps outside of core. For those apps:
+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.
 
-* ``learning_publishing`` has no dependencies. All the other apps depend on it.
-* ``learning_composition`` and ``learning_navigation`` both depend on ``learning_partitioning``
 
 Model Conventions
 ~~~~~~~~~~~~~~~~~
@@ -74,7 +69,7 @@ We have a few different identifier types in the schema, and we try to avoid ``_i
 
 * ``id`` is the auto-generated, internal row ID and primary key. This never changes. Data models should make foreign keys to this field, as per Django convention.
 * ``uuid`` is a randomly generated UUID4. This is the stable way to refer to a row/resource from an external service. This never changes. This is separate from ``id`` mostly because there are performance penalties when using UUIDs as primary keys with MySQL.
-* ``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.
+* ``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.
 
 
@@ -89,7 +84,7 @@ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthe
 Code Overview
 -------------
 
-The ``openedx_learning.apps`` package contains all our Django applications. All apps are named with a ``learning_`` prefix to better avoid name conflicts, because Django's app namespace is flat. Apps will adhere to `OEP-0049: Django App Patterns <https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0049-django-app-patterns.html>`_.
+The ``openedx_learning.apps`` package contains all our Django applications.
 
 Development Workflow
 --------------------
@@ -103,7 +98,7 @@ One Time Setup
   cd openedx-learning
 
   # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
-  mkvirtualenv -p python3.8 openedx-learning
+  mkvirtualenv -p python3.11 openedx-learning
 
 
 Every time you develop something in this repo

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/openedx_learning.egg-info/SOURCES.txt

@@ -12,36 +12,40 @@ openedx_learning.egg-info/dependency_links.txt
 openedx_learning.egg-info/not-zip-safe
 openedx_learning.egg-info/requires.txt
 openedx_learning.egg-info/top_level.txt
+openedx_learning/api/__init__.py
+openedx_learning/api/authoring.py
+openedx_learning/api/authoring_models.py
+openedx_learning/apps/__init__.py
+openedx_learning/apps/authoring/__init__.py
+openedx_learning/apps/authoring/components/__init__.py
+openedx_learning/apps/authoring/components/admin.py
+openedx_learning/apps/authoring/components/api.py
+openedx_learning/apps/authoring/components/apps.py
+openedx_learning/apps/authoring/components/models.py
+openedx_learning/apps/authoring/components/migrations/0001_initial.py
+openedx_learning/apps/authoring/components/migrations/0002_alter_componentversioncontent_key.py
+openedx_learning/apps/authoring/components/migrations/__init__.py
+openedx_learning/apps/authoring/contents/__init__.py
+openedx_learning/apps/authoring/contents/admin.py
+openedx_learning/apps/authoring/contents/api.py
+openedx_learning/apps/authoring/contents/apps.py
+openedx_learning/apps/authoring/contents/models.py
+openedx_learning/apps/authoring/contents/migrations/0001_initial.py
+openedx_learning/apps/authoring/contents/migrations/__init__.py
+openedx_learning/apps/authoring/publishing/__init__.py
+openedx_learning/apps/authoring/publishing/admin.py
+openedx_learning/apps/authoring/publishing/api.py
+openedx_learning/apps/authoring/publishing/apps.py
+openedx_learning/apps/authoring/publishing/model_mixins.py
+openedx_learning/apps/authoring/publishing/models.py
+openedx_learning/apps/authoring/publishing/migrations/0001_initial.py
+openedx_learning/apps/authoring/publishing/migrations/0002_alter_learningpackage_key_and_more.py
+openedx_learning/apps/authoring/publishing/migrations/__init__.py
 openedx_learning/contrib/__init__.py
 openedx_learning/contrib/media_server/__init__.py
 openedx_learning/contrib/media_server/apps.py
 openedx_learning/contrib/media_server/urls.py
 openedx_learning/contrib/media_server/views.py
-openedx_learning/core/__init__.py
-openedx_learning/core/components/__init__.py
-openedx_learning/core/components/admin.py
-openedx_learning/core/components/api.py
-openedx_learning/core/components/apps.py
-openedx_learning/core/components/models.py
-openedx_learning/core/components/migrations/0001_initial.py
-openedx_learning/core/components/migrations/0002_alter_componentversioncontent_key.py
-openedx_learning/core/components/migrations/__init__.py
-openedx_learning/core/contents/__init__.py
-openedx_learning/core/contents/admin.py
-openedx_learning/core/contents/api.py
-openedx_learning/core/contents/apps.py
-openedx_learning/core/contents/models.py
-openedx_learning/core/contents/migrations/0001_initial.py
-openedx_learning/core/contents/migrations/__init__.py
-openedx_learning/core/publishing/__init__.py
-openedx_learning/core/publishing/admin.py
-openedx_learning/core/publishing/api.py
-openedx_learning/core/publishing/apps.py
-openedx_learning/core/publishing/model_mixins.py
-openedx_learning/core/publishing/models.py
-openedx_learning/core/publishing/migrations/0001_initial.py
-openedx_learning/core/publishing/migrations/0002_alter_learningpackage_key_and_more.py
-openedx_learning/core/publishing/migrations/__init__.py
 openedx_learning/lib/__init__.py
 openedx_learning/lib/admin_utils.py
 openedx_learning/lib/cache.py
@@ -50,12 +54,6 @@ openedx_learning/lib/fields.py
 openedx_learning/lib/managers.py
 openedx_learning/lib/test_utils.py
 openedx_learning/lib/validators.py
-openedx_learning/rest_api/__init__.py
-openedx_learning/rest_api/apps.py
-openedx_learning/rest_api/urls.py
-openedx_learning/rest_api/v1/__init__.py
-openedx_learning/rest_api/v1/components.py
-openedx_learning/rest_api/v1/urls.py
 openedx_tagging/__init__.py
 openedx_tagging/py.typed
 openedx_tagging/core/__init__.py

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/setup.py

@@ -67,7 +67,7 @@ CHANGELOG = open(os.path.join(os.path.dirname(__file__), 'CHANGELOG.rst')).read(
 setup(
     name='openedx-learning',
     version=VERSION,
-    description="""An experiment.""",
+    description="""Open edX Learning Core and Tagging.""",
     long_description=README + '\n\n' + CHANGELOG,
     author='David Ormsbee',
     author_email='dave@tcril.org',

openedx_learning-0.9.4/openedx_learning/rest_api/apps.py

@@ -1,14 +0,0 @@
-"""
-Django metadata for the Learning Core REST API app
-"""
-from django.apps import AppConfig
-
-
-class RESTAPIConfig(AppConfig):
-    """
-    Configuration for the Learning Core REST API Django app.
-    """
-
-    name = "openedx_learning.rest_api"
-    verbose_name = "Learning Core: REST API"
-    default_auto_field = "django.db.models.BigAutoField"

openedx_learning-0.9.4/openedx_learning/rest_api/urls.py

@@ -1,6 +0,0 @@
-"""
-URLs for the Learning Core REST API
-"""
-from django.urls import include, path
-
-urlpatterns = [path("v1/", include("openedx_learning.rest_api.v1.urls"))]

openedx_learning-0.9.4/openedx_learning/rest_api/v1/components.py

@@ -1,30 +0,0 @@
-"""
-This is just an example REST API endpoint.
-"""
-from rest_framework import viewsets
-
-from openedx_learning.core.components.models import Component
-
-
-class ComponentViewSet(viewsets.ViewSet):
-    """
-    Example endpoints for a Components REST API. Not implemented.
-    """
-    def list(self, request):
-        _items = Component.objects.all()
-        raise NotImplementedError
-
-    def retrieve(self, request, pk=None):
-        raise NotImplementedError
-
-    def create(self, request):
-        raise NotImplementedError
-
-    def update(self, request, pk=None):
-        raise NotImplementedError
-
-    def partial_update(self, request, pk=None):
-        raise NotImplementedError
-
-    def destroy(self, request, pk=None):
-        raise NotImplementedError

openedx_learning-0.9.4/openedx_learning/rest_api/v1/urls.py

@@ -1,10 +0,0 @@
-"""
-URLs for the Learning Core REST API v1
-"""
-from rest_framework.routers import DefaultRouter
-
-from . import components
-
-router = DefaultRouter()
-router.register(r"components", components.ComponentViewSet, basename="component")
-urlpatterns = router.urls

{openedx_learning-0.9.4 → openedx_learning-0.10.0}/openedx_learning.egg-info/requires.txt

@@ -1,6 +1,6 @@
-edx-drf-extensions
 rules<4.0
-celery
 Django<5.0
+edx-drf-extensions
 attrs
+celery
 djangorestframework<4.0