version bump 0.28.0

.annotation_safe_list.yml

@@ -13,9 +13,69 @@ auth.Group:
   ".. no_pii:": "This model has no PII"
 auth.Permission:
   ".. no_pii:": "This model has no PII"
+auth.User:
+  ".. pii": "This model minimally contains a username, password, and email"
+  ".. pii_types": "username, email_address, password"
+  ".. pii_retirement": "consumer_api"
 contenttypes.ContentType:
   ".. no_pii:": "This model has no PII"
-sessions.Session:
+oel_collections.Collection:
+  ".. no_pii:": "This model has no PII"
+oel_collections.CollectionPublishableEntity:
+  ".. no_pii:": "This model has no PII"
+oel_components.Component:
+  ".. no_pii:": "This model has no PII"
+oel_components.ComponentType:
+  ".. no_pii:": "This model has no PII"
+oel_components.ComponentVersion:
+  ".. no_pii:": "This model has no PII"
+oel_components.ComponentVersionContent:
+  ".. no_pii:": "This model has no PII"
+oel_contents.Content:
+  ".. no_pii:": "This model has no PII"
+oel_contents.MediaType:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.Container:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.ContainerVersion:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.Draft:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.EntityList:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.EntityListRow:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.LearningPackage:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.PublishLog:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.PublishLogRecord:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.PublishableEntity:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.PublishableEntityVersion:
+  ".. no_pii:": "This model has no PII"
+oel_publishing.Published:
+  ".. no_pii:": "This model has no PII"
+oel_tagging.ObjectTag:
+  ".. no_pii:": "This model has no PII"
+oel_tagging.Tag:
+  ".. no_pii:": "This model has no PII"
+oel_tagging.TagImportTask:
+  ".. no_pii:": "This model has no PII"
+oel_tagging.Taxonomy:
+  ".. no_pii:": "This model has no PII"
+oel_sections.Section:
+  ".. no_pii:": "This model has no PII"
+oel_sections.SectionVersion:
+  ".. no_pii:": "This model has no PII"
+oel_subsections.Subsection:
+  ".. no_pii:": "This model has no PII"
+oel_subsections.SubsectionVersion:
+  ".. no_pii:": "This model has no PII"
+oel_units.Unit:
+  ".. no_pii:": "This model has no PII"
+oel_units.UnitVersion:
   ".. no_pii:": "This model has no PII"
 social_django.Association:
   ".. no_pii:": "This model has no PII"
@@ -29,6 +89,8 @@ social_django.Partial:
   ".. no_pii:": "This model has no PII"
 social_django.UserSocialAuth:
   ".. no_pii:": "This model has no PII"
+sessions.Session:
+  ".. no_pii:": "This model has no PII"
 waffle.Flag:
   ".. no_pii:": "This model has no PII"
 waffle.Sample:

.coveragerc

@@ -1,10 +1,13 @@
 [run]
 branch = True
 data_file = .coverage
-source=openedx_learning
+source =
+	openedx_learning
+	openedx_tagging
 omit =
     test_settings
-    *migrations*
+    **/migrations/*
     *admin.py
     *static*
     *templates*
+    **/tests/**

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+    # Adding new check for github-actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+        interval: "weekly"

.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches:
+      - '**'
+
+
+jobs:
+  run_tests:
+    name: tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      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.
+        mysql-version: ["8"]
+    services:
+      mysql:
+        image: mysql:${{ matrix.mysql-version }}
+        ports:
+          - 3306:3306
+        env:
+          MYSQL_DATABASE: "test_oel_db"
+          MYSQL_USER: "test_oel_user"
+          MYSQL_PASSWORD: "test_oel_pass"
+          MYSQL_RANDOM_ROOT_PASSWORD: true
+        # these options are blatantly copied from edx-platform's values
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+    steps:
+      - uses: actions/checkout@v5
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install pip
+        run: pip install -r requirements/pip.txt
+
+      - name: Install Dependencies
+        run: pip install -r requirements/ci.txt
+
+      - name: Run Tests
+        env:
+          TOXENV: ${{ matrix.toxenv }}
+        run: tox -e ${{ matrix.toxenv }}
+

.github/workflows/lint-imports.yml

@@ -0,0 +1,29 @@
+name: Lint Imports
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches:
+      - '**'
+
+
+jobs:
+  lint-imports:
+    name: Lint Python Imports
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install pip
+        run: pip install -r requirements/pip.txt
+
+      - name: Install Dependencies
+        run: pip install -r requirements/ci.txt
+
+      - name: Analyze imports
+        run: lint-imports

.github/workflows/pypi-publish.yml

@@ -0,0 +1,30 @@
+name: Publish package to PyPI
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install pip
+        run: pip install -r requirements/pip.txt
+
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_UPLOAD_TOKEN }}

.github/workflows/upgrade-python-requirements.yml

@@ -0,0 +1,31 @@
+name: Upgrade Python Requirements
+
+on:
+  schedule:
+    - cron: "0 0 * * 1"
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "Target branch against which to create requirements PR"
+        required: true
+        # If copying this template manually, you must provide your default branch name
+        # in quotes, such as 'master'
+        default: "main"
+
+jobs:
+  call-upgrade-python-requirements-workflow:
+    uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master
+    with:
+    # If copying manually, also provide your default branch name in quotes here
+      branch: ${{ github.event.inputs.branch || 'main' }}
+      # optional parameters below; fill in if you'd like github or email notifications
+      # user_reviewers: ""
+      team_reviewers: "axim-aximprovements"
+      email_address: "aximimprovements@axim.org"
+      send_success_notification: false
+      # python_version: ""
+    secrets:
+      requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}
+      requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
+      edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }}
+      edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }}

.gitignore

@@ -26,6 +26,7 @@ pip-log.txt
 # Unit test / coverage reports
 .cache/
 .pytest_cache/
+.mypy_cache/
 .coverage
 .coverage.*
 .tox
@@ -61,7 +62,13 @@ requirements/private.in
 requirements/private.txt
 
 # database file
-dev.db
+dev.db*
 
 .vscode
+venv/
 
+# Media files (for uploads)
+media/
+
+# Media files generated during test runs
+test_media/

.importlinter

@@ -23,22 +23,37 @@ name = Lib / Core / Contrib Layering
 type = layers
 layers=
     openedx_learning.contrib
-    openedx_learning.core
+    openedx_learning.apps
     openedx_learning.lib
 
-# This is layering within our Core apps.
-#
-# The lowest layer is "publishing", which holds the basic primitives needed to
-# create LearningPackages and versioning.
-#
-# One layer above that is "itemstore" which stores single Items (e.g. Problem,
-# Video).
-#
-# Above "itemstore" are apps that can compose those Items into more interesting
-# structures (like Units).
+# 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 = Core App Dependency Layering
+name = Authoring App Dependency Layering
 type = layers
 layers=
-    openedx_learning.core.components
-    openedx_learning.core.publishing
+    # The public authoring API is at the top–none of the apps should call to it.
+    openedx_learning.api.authoring
+
+    # The "backup_restore" app handle the new export and import mechanism.
+    openedx_learning.apps.authoring.backup_restore
+
+    # The "components" app is responsible for storing versioned Components,
+    # which is 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.authoring.components
+
+    # The "contents" app stores the simplest pieces of binary and text data,
+    # without versioning information. These belong to a single Learning Package.
+    openedx_learning.apps.authoring.contents
+
+    # The "collections" app stores arbitrary groupings of PublishableEntities.
+    # Its only dependency should be the publishing app.
+    openedx_learning.apps.authoring.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.authoring.publishing

.readthedocs.yml → .readthedocs.yaml

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

CHANGELOG.rst

@@ -14,7 +14,10 @@ Change Log
 Unreleased
 ~~~~~~~~~~
 
-*
+* Removed usage of ``tox-battery`` and added support for ``tox 4.0``
+* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
+  deprecated.  See https://github.com/openedx/edx-sphinx-theme/issues/184 for
+  more details.  
 
 [0.1.0] - 2021-08-08
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MANIFEST.in

@@ -3,3 +3,4 @@ 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