openedx-learning 0.6.2__tar.gz → 0.8.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. openedx-learning-0.8.0/PKG-INFO +225 -0
  2. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/__init__.py +1 -1
  3. openedx-learning-0.8.0/openedx_learning.egg-info/PKG-INFO +225 -0
  4. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/SOURCES.txt +3 -0
  5. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/admin.py +1 -1
  6. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/api.py +115 -37
  7. openedx-learning-0.8.0/openedx_tagging/core/tagging/migrations/0016_object_tag_export_id.py +62 -0
  8. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/models/base.py +40 -23
  9. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/models/utils.py +10 -0
  10. openedx-learning-0.8.0/openedx_tagging/core/tagging/rest_api/v1/__init__.py +0 -0
  11. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/v1/serializers.py +3 -2
  12. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/v1/views.py +6 -1
  13. openedx-learning-0.8.0/openedx_tagging/py.typed +0 -0
  14. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/setup.py +1 -0
  15. openedx-learning-0.6.2/PKG-INFO +0 -218
  16. openedx-learning-0.6.2/openedx_learning.egg-info/PKG-INFO +0 -218
  17. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/CHANGELOG.rst +0 -0
  18. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/LICENSE.txt +0 -0
  19. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/MANIFEST.in +0 -0
  20. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/README.rst +0 -0
  21. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/contrib/__init__.py +0 -0
  22. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/contrib/media_server/__init__.py +0 -0
  23. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/contrib/media_server/apps.py +0 -0
  24. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/contrib/media_server/urls.py +0 -0
  25. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/contrib/media_server/views.py +0 -0
  26. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/__init__.py +0 -0
  27. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/__init__.py +0 -0
  28. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/admin.py +0 -0
  29. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/api.py +0 -0
  30. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/apps.py +0 -0
  31. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/migrations/0001_initial.py +0 -0
  32. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/migrations/0002_alter_componentversioncontent_key.py +0 -0
  33. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/migrations/__init__.py +0 -0
  34. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/components/models.py +0 -0
  35. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/__init__.py +0 -0
  36. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/admin.py +0 -0
  37. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/api.py +0 -0
  38. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/apps.py +0 -0
  39. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/migrations/0001_initial.py +0 -0
  40. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/migrations/__init__.py +0 -0
  41. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/contents/models.py +0 -0
  42. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/__init__.py +0 -0
  43. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/admin.py +0 -0
  44. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/api.py +0 -0
  45. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/apps.py +0 -0
  46. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/migrations/0001_initial.py +0 -0
  47. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/migrations/0002_alter_learningpackage_key_and_more.py +0 -0
  48. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/migrations/__init__.py +0 -0
  49. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/model_mixins.py +0 -0
  50. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/core/publishing/models.py +0 -0
  51. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/__init__.py +0 -0
  52. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/admin_utils.py +0 -0
  53. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/cache.py +0 -0
  54. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/collations.py +0 -0
  55. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/fields.py +0 -0
  56. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/managers.py +0 -0
  57. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/test_utils.py +0 -0
  58. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/lib/validators.py +0 -0
  59. openedx-learning-0.6.2/openedx_learning/rest_api/__init__.py → openedx-learning-0.8.0/openedx_learning/py.typed +0 -0
  60. {openedx-learning-0.6.2/openedx_learning/rest_api/v1 → openedx-learning-0.8.0/openedx_learning/rest_api}/__init__.py +0 -0
  61. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/rest_api/apps.py +0 -0
  62. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/rest_api/urls.py +0 -0
  63. {openedx-learning-0.6.2/openedx_tagging/core → openedx-learning-0.8.0/openedx_learning/rest_api/v1}/__init__.py +0 -0
  64. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/rest_api/v1/components.py +0 -0
  65. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/rest_api/v1/urls.py +0 -0
  66. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/dependency_links.txt +0 -0
  67. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/not-zip-safe +0 -0
  68. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/requires.txt +3 -3
  69. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/top_level.txt +0 -0
  70. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/__init__.py +0 -0
  71. {openedx-learning-0.6.2/openedx_tagging/core/tagging → openedx-learning-0.8.0/openedx_tagging/core}/__init__.py +0 -0
  72. {openedx-learning-0.6.2/openedx_tagging/core/tagging/migrations → openedx-learning-0.8.0/openedx_tagging/core/tagging}/__init__.py +0 -0
  73. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/apps.py +0 -0
  74. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/data.py +0 -0
  75. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/__init__.py +0 -0
  76. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/actions.py +0 -0
  77. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/api.py +0 -0
  78. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/exceptions.py +0 -0
  79. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/import_plan.py +0 -0
  80. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/parsers.py +0 -0
  81. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/tasks.py +0 -0
  82. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/template.csv +0 -0
  83. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/import_export/template.json +0 -0
  84. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0001_initial.py +0 -0
  85. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0001_squashed.py +0 -0
  86. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0002_auto_20230718_2026.py +0 -0
  87. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0003_auto_20230721_1238.py +0 -0
  88. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0004_auto_20230723_2001.py +0 -0
  89. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0005_language_taxonomy.py +0 -0
  90. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0006_alter_objecttag_unique_together.py +0 -0
  91. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0006_auto_20230802_1631.py +0 -0
  92. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0007_tag_import_task_log_null_fix.py +0 -0
  93. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0008_taxonomy_description_not_null.py +0 -0
  94. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0009_alter_objecttag_object_id.py +0 -0
  95. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0010_cleanups.py +0 -0
  96. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0011_remove_required.py +0 -0
  97. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0012_language_taxonomy.py +0 -0
  98. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0013_tag_parent_blank.py +0 -0
  99. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0014_minor_fixes.py +0 -0
  100. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/migrations/0015_taxonomy_export_id.py +0 -0
  101. {openedx-learning-0.6.2/openedx_tagging/core/tagging/rest_api → openedx-learning-0.8.0/openedx_tagging/core/tagging/migrations}/__init__.py +0 -0
  102. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/models/__init__.py +0 -0
  103. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/models/import_export.py +0 -0
  104. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/models/system_defined.py +0 -0
  105. {openedx-learning-0.6.2/openedx_tagging/core/tagging/rest_api/v1 → openedx-learning-0.8.0/openedx_tagging/core/tagging/rest_api}/__init__.py +0 -0
  106. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/paginators.py +0 -0
  107. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/urls.py +0 -0
  108. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/utils.py +0 -0
  109. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/v1/permissions.py +0 -0
  110. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/v1/urls.py +0 -0
  111. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rest_api/v1/views_import.py +0 -0
  112. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/rules.py +0 -0
  113. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/urls.py +0 -0
  114. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/requirements/base.in +0 -0
  115. {openedx-learning-0.6.2 → openedx-learning-0.8.0}/setup.cfg +0 -0
openedx-learning-0.8.0/PKG-INFO ADDED
@@ -0,0 +1,225 @@
1
+ Metadata-Version: 2.1
2
+ Name: openedx-learning
3
+ Version: 0.8.0
4
+ Summary: An experiment.
5
+ Home-page: https://github.com/openedx/openedx-learning
6
+ Author: David Ormsbee
7
+ Author-email: dave@tcril.org
8
+ License: AGPL 3.0
9
+ Keywords: Python edx
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Framework :: Django
12
+ Classifier: Framework :: Django :: 3.2
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
15
+ Classifier: Natural Language :: English
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Requires-Python: >=3.8
20
+ License-File: LICENSE.txt
21
+ Requires-Dist: rules<4.0
22
+ Requires-Dist: Django<5.0
23
+ Requires-Dist: edx-drf-extensions
24
+ Requires-Dist: attrs
25
+ Requires-Dist: djangorestframework<4.0
26
+ Requires-Dist: celery
27
+
28
+ openedx-learning
29
+ =============================
30
+
31
+ |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
32
+ |license-badge|
33
+
34
+ This is experimentation/prototyping and not in any way production ready!
35
+ ------------------------------------------------------------------------
36
+
37
+ Overview
38
+ --------
39
+
40
+ The Open edX Learning repository holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform.
41
+
42
+ Motivation
43
+ ----------
44
+
45
+ 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 edx-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.
46
+
47
+ Replacing edx-platform is explicitly *not* a goal of this project, as only a small fraction of the concepts in edx-platform make sense to carry over here. When these core concepts are extracted and the data migrated, edx-platform will import apps from this repo and make use of their public in-process APIs.
48
+
49
+ Architecture
50
+ ------------
51
+
52
+ Parts
53
+ ~~~~~
54
+
55
+ * ``openedx_learning.lib`` is for shared utilities, and may include things like custom field types, plugin registration code, etc.
56
+ * ``openedx_learning.core`` contains our Core Django apps, where foundational data structures and APIs will live.
57
+ * ``openedx_tagging.core`` contains the core Tagging app, which provides data structures and apis for tagging Open edX objects.
58
+
59
+ App Dependencies
60
+ ~~~~~~~~~~~~~~~~
61
+
62
+ Anything can import from ``openedx_learning.lib``.
63
+
64
+ Core apps can import from each other, but cannot import from other apps outside of core. For those apps:
65
+
66
+ * ``learning_publishing`` has no dependencies. All the other apps depend on it.
67
+ * ``learning_composition`` and ``learning_navigation`` both depend on ``learning_partitioning``
68
+
69
+ Model Conventions
70
+ ~~~~~~~~~~~~~~~~~
71
+
72
+ We have a few different identifier types in the schema, and we try to avoid ``_id`` for this because Django uses that convention to reference IDs in other models/tables. So instead we have:
73
+
74
+ * ``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.
75
+ * ``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.
76
+ * ``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.
77
+ * ``num`` is like ``key``, but for use when it's strictly numeric. It can also be used as a suffix.
78
+
79
+
80
+ See Also
81
+ ~~~~~~~~
82
+
83
+ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0049-django-app-patterns.html) where possible, and also borrows inspiration from:
84
+
85
+ * [Scaling Django to 500 apps](https://2021.djangocon.us/talks/scaling-django-to-500-apps/) (Dan Palmer, DjangoCon US 2021)
86
+ * [Django structure for scale and longevity](https://www.youtube.com/watch?v=yG3ZdxBb1oo) (Radoslav Georgiev, EuroPython 2018)
87
+
88
+ Code Overview
89
+ -------------
90
+
91
+ 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>`_.
92
+
93
+ Development Workflow
94
+ --------------------
95
+
96
+ One Time Setup
97
+ ~~~~~~~~~~~~~~
98
+ .. code-block::
99
+
100
+ # Clone the repository
101
+ git clone git@github.com:ormsbee/openedx-learning.git
102
+ cd openedx-learning
103
+
104
+ # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
105
+ mkvirtualenv -p python3.8 openedx-learning
106
+
107
+
108
+ Every time you develop something in this repo
109
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110
+ .. code-block::
111
+
112
+ # Activate the virtualenv
113
+ workon openedx-learning
114
+
115
+ # Grab the latest code
116
+ git checkout master
117
+ git pull
118
+
119
+ # Install/update the dev requirements
120
+ make requirements
121
+
122
+ # Run the tests and quality checks (to verify the status before you make any changes)
123
+ make validate
124
+
125
+ # Make a new branch for your changes
126
+ git checkout -b <your_github_username>/<short_description>
127
+
128
+ # Using your favorite editor, edit the code to make your change.
129
+ vim …
130
+
131
+ # Run your new tests
132
+ pytest ./path/to/new/tests
133
+
134
+ # Run all the tests and quality checks
135
+ make validate
136
+
137
+ # Commit all your changes
138
+ git commit …
139
+ git push
140
+
141
+ # Open a PR and ask for review.
142
+
143
+ License
144
+ -------
145
+
146
+ The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
147
+
148
+ Please see `LICENSE.txt <LICENSE.txt>`_ for details.
149
+
150
+ How To Contribute
151
+ -----------------
152
+
153
+ This repo is in a very experimental state. Discussion using GitHub Issues is welcome, but you probably don't want to make contributions as everything can shift around drastically with little notice.
154
+
155
+ Reporting Security Issues
156
+ -------------------------
157
+
158
+ Please do not report security issues in public. Please email security@openedx.org.
159
+
160
+ Help
161
+ ----
162
+
163
+ If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
164
+
165
+ Our real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.
166
+
167
+ For more information about these options, see the `Getting Help`_ page.
168
+
169
+ .. _Slack invitation: https://openedx.org/slack
170
+ .. _community Slack workspace: https://openedx.slack.com/
171
+ .. _Getting Help: https://openedx.org/getting-help
172
+
173
+ .. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-learning.svg
174
+ :target: https://pypi.python.org/pypi/openedx-learning/
175
+ :alt: PyPI
176
+
177
+ .. |ci-badge| image:: https://github.com/openedx/openedx-learning/workflows/Python%20CI/badge.svg?branch=master
178
+ :target: https://github.com/openedx/openedx-learning/actions
179
+ :alt: CI
180
+
181
+ .. |codecov-badge| image:: https://codecov.io/github/edx/openedx-learning/coverage.svg?branch=master
182
+ :target: https://codecov.io/github/edx/openedx-learning?branch=master
183
+ :alt: Codecov
184
+
185
+ .. |doc-badge| image:: https://readthedocs.org/projects/openedx-learning/badge/?version=latest
186
+ :target: https://openedx-learning.readthedocs.io/en/latest/
187
+ :alt: Documentation
188
+
189
+ .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-learning.svg
190
+ :target: https://pypi.python.org/pypi/openedx-learning/
191
+ :alt: Supported Python versions
192
+
193
+ .. |license-badge| image:: https://img.shields.io/github/license/edx/openedx-learning.svg
194
+ :target: https://github.com/openedx/openedx-learning/blob/master/LICENSE.txt
195
+ :alt: License
196
+
197
+
198
+ Change Log
199
+ ----------
200
+
201
+ ..
202
+ All enhancements and patches to openedx-learning will be documented
203
+ in this file. It adheres to the structure of https://keepachangelog.com/ ,
204
+ but in reStructuredText instead of Markdown (for ease of incorporation into
205
+ Sphinx documentation and the PyPI description).
206
+
207
+ This project adheres to Semantic Versioning (https://semver.org/).
208
+
209
+ .. There should always be an "Unreleased" section for changes pending release.
210
+
211
+ Unreleased
212
+ ~~~~~~~~~~
213
+
214
+ * Removed usage of ``tox-battery`` and added support for ``tox 4.0``
215
+ * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
216
+ deprecated. See https://github.com/openedx/edx-sphinx-theme/issues/184 for
217
+ more details.
218
+
219
+ [0.1.0] - 2021-08-08
220
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
+
222
+ Added
223
+ _____
224
+
225
+ * First release on PyPI.
{openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning/__init__.py RENAMED
@@ -1,4 +1,4 @@
1
1
  """
2
2
  Open edX Learning ("Learning Core").
3
3
  """
4
- __version__ = "0.6.2"
4
+ __version__ = "0.8.0"
openedx-learning-0.8.0/openedx_learning.egg-info/PKG-INFO ADDED
@@ -0,0 +1,225 @@
1
+ Metadata-Version: 2.1
2
+ Name: openedx-learning
3
+ Version: 0.8.0
4
+ Summary: An experiment.
5
+ Home-page: https://github.com/openedx/openedx-learning
6
+ Author: David Ormsbee
7
+ Author-email: dave@tcril.org
8
+ License: AGPL 3.0
9
+ Keywords: Python edx
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Framework :: Django
12
+ Classifier: Framework :: Django :: 3.2
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
15
+ Classifier: Natural Language :: English
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Requires-Python: >=3.8
20
+ License-File: LICENSE.txt
21
+ Requires-Dist: rules<4.0
22
+ Requires-Dist: Django<5.0
23
+ Requires-Dist: edx-drf-extensions
24
+ Requires-Dist: attrs
25
+ Requires-Dist: djangorestframework<4.0
26
+ Requires-Dist: celery
27
+
28
+ openedx-learning
29
+ =============================
30
+
31
+ |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
32
+ |license-badge|
33
+
34
+ This is experimentation/prototyping and not in any way production ready!
35
+ ------------------------------------------------------------------------
36
+
37
+ Overview
38
+ --------
39
+
40
+ The Open edX Learning repository holds Django apps that represent core learning concepts and data models that have been extracted from edx-platform.
41
+
42
+ Motivation
43
+ ----------
44
+
45
+ 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 edx-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.
46
+
47
+ Replacing edx-platform is explicitly *not* a goal of this project, as only a small fraction of the concepts in edx-platform make sense to carry over here. When these core concepts are extracted and the data migrated, edx-platform will import apps from this repo and make use of their public in-process APIs.
48
+
49
+ Architecture
50
+ ------------
51
+
52
+ Parts
53
+ ~~~~~
54
+
55
+ * ``openedx_learning.lib`` is for shared utilities, and may include things like custom field types, plugin registration code, etc.
56
+ * ``openedx_learning.core`` contains our Core Django apps, where foundational data structures and APIs will live.
57
+ * ``openedx_tagging.core`` contains the core Tagging app, which provides data structures and apis for tagging Open edX objects.
58
+
59
+ App Dependencies
60
+ ~~~~~~~~~~~~~~~~
61
+
62
+ Anything can import from ``openedx_learning.lib``.
63
+
64
+ Core apps can import from each other, but cannot import from other apps outside of core. For those apps:
65
+
66
+ * ``learning_publishing`` has no dependencies. All the other apps depend on it.
67
+ * ``learning_composition`` and ``learning_navigation`` both depend on ``learning_partitioning``
68
+
69
+ Model Conventions
70
+ ~~~~~~~~~~~~~~~~~
71
+
72
+ We have a few different identifier types in the schema, and we try to avoid ``_id`` for this because Django uses that convention to reference IDs in other models/tables. So instead we have:
73
+
74
+ * ``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.
75
+ * ``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.
76
+ * ``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.
77
+ * ``num`` is like ``key``, but for use when it's strictly numeric. It can also be used as a suffix.
78
+
79
+
80
+ See Also
81
+ ~~~~~~~~
82
+
83
+ The structure of this repo follows [OEP-0049](https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0049-django-app-patterns.html) where possible, and also borrows inspiration from:
84
+
85
+ * [Scaling Django to 500 apps](https://2021.djangocon.us/talks/scaling-django-to-500-apps/) (Dan Palmer, DjangoCon US 2021)
86
+ * [Django structure for scale and longevity](https://www.youtube.com/watch?v=yG3ZdxBb1oo) (Radoslav Georgiev, EuroPython 2018)
87
+
88
+ Code Overview
89
+ -------------
90
+
91
+ 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>`_.
92
+
93
+ Development Workflow
94
+ --------------------
95
+
96
+ One Time Setup
97
+ ~~~~~~~~~~~~~~
98
+ .. code-block::
99
+
100
+ # Clone the repository
101
+ git clone git@github.com:ormsbee/openedx-learning.git
102
+ cd openedx-learning
103
+
104
+ # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
105
+ mkvirtualenv -p python3.8 openedx-learning
106
+
107
+
108
+ Every time you develop something in this repo
109
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110
+ .. code-block::
111
+
112
+ # Activate the virtualenv
113
+ workon openedx-learning
114
+
115
+ # Grab the latest code
116
+ git checkout master
117
+ git pull
118
+
119
+ # Install/update the dev requirements
120
+ make requirements
121
+
122
+ # Run the tests and quality checks (to verify the status before you make any changes)
123
+ make validate
124
+
125
+ # Make a new branch for your changes
126
+ git checkout -b <your_github_username>/<short_description>
127
+
128
+ # Using your favorite editor, edit the code to make your change.
129
+ vim …
130
+
131
+ # Run your new tests
132
+ pytest ./path/to/new/tests
133
+
134
+ # Run all the tests and quality checks
135
+ make validate
136
+
137
+ # Commit all your changes
138
+ git commit …
139
+ git push
140
+
141
+ # Open a PR and ask for review.
142
+
143
+ License
144
+ -------
145
+
146
+ The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
147
+
148
+ Please see `LICENSE.txt <LICENSE.txt>`_ for details.
149
+
150
+ How To Contribute
151
+ -----------------
152
+
153
+ This repo is in a very experimental state. Discussion using GitHub Issues is welcome, but you probably don't want to make contributions as everything can shift around drastically with little notice.
154
+
155
+ Reporting Security Issues
156
+ -------------------------
157
+
158
+ Please do not report security issues in public. Please email security@openedx.org.
159
+
160
+ Help
161
+ ----
162
+
163
+ If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
164
+
165
+ Our real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.
166
+
167
+ For more information about these options, see the `Getting Help`_ page.
168
+
169
+ .. _Slack invitation: https://openedx.org/slack
170
+ .. _community Slack workspace: https://openedx.slack.com/
171
+ .. _Getting Help: https://openedx.org/getting-help
172
+
173
+ .. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-learning.svg
174
+ :target: https://pypi.python.org/pypi/openedx-learning/
175
+ :alt: PyPI
176
+
177
+ .. |ci-badge| image:: https://github.com/openedx/openedx-learning/workflows/Python%20CI/badge.svg?branch=master
178
+ :target: https://github.com/openedx/openedx-learning/actions
179
+ :alt: CI
180
+
181
+ .. |codecov-badge| image:: https://codecov.io/github/edx/openedx-learning/coverage.svg?branch=master
182
+ :target: https://codecov.io/github/edx/openedx-learning?branch=master
183
+ :alt: Codecov
184
+
185
+ .. |doc-badge| image:: https://readthedocs.org/projects/openedx-learning/badge/?version=latest
186
+ :target: https://openedx-learning.readthedocs.io/en/latest/
187
+ :alt: Documentation
188
+
189
+ .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-learning.svg
190
+ :target: https://pypi.python.org/pypi/openedx-learning/
191
+ :alt: Supported Python versions
192
+
193
+ .. |license-badge| image:: https://img.shields.io/github/license/edx/openedx-learning.svg
194
+ :target: https://github.com/openedx/openedx-learning/blob/master/LICENSE.txt
195
+ :alt: License
196
+
197
+
198
+ Change Log
199
+ ----------
200
+
201
+ ..
202
+ All enhancements and patches to openedx-learning will be documented
203
+ in this file. It adheres to the structure of https://keepachangelog.com/ ,
204
+ but in reStructuredText instead of Markdown (for ease of incorporation into
205
+ Sphinx documentation and the PyPI description).
206
+
207
+ This project adheres to Semantic Versioning (https://semver.org/).
208
+
209
+ .. There should always be an "Unreleased" section for changes pending release.
210
+
211
+ Unreleased
212
+ ~~~~~~~~~~
213
+
214
+ * Removed usage of ``tox-battery`` and added support for ``tox 4.0``
215
+ * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
216
+ deprecated. See https://github.com/openedx/edx-sphinx-theme/issues/184 for
217
+ more details.
218
+
219
+ [0.1.0] - 2021-08-08
220
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
+
222
+ Added
223
+ _____
224
+
225
+ * First release on PyPI.
{openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_learning.egg-info/SOURCES.txt RENAMED
@@ -5,6 +5,7 @@ README.rst
5
5
  setup.cfg
6
6
  setup.py
7
7
  openedx_learning/__init__.py
8
+ openedx_learning/py.typed
8
9
  openedx_learning.egg-info/PKG-INFO
9
10
  openedx_learning.egg-info/SOURCES.txt
10
11
  openedx_learning.egg-info/dependency_links.txt
@@ -56,6 +57,7 @@ openedx_learning/rest_api/v1/__init__.py
56
57
  openedx_learning/rest_api/v1/components.py
57
58
  openedx_learning/rest_api/v1/urls.py
58
59
  openedx_tagging/__init__.py
60
+ openedx_tagging/py.typed
59
61
  openedx_tagging/core/__init__.py
60
62
  openedx_tagging/core/tagging/__init__.py
61
63
  openedx_tagging/core/tagging/admin.py
@@ -90,6 +92,7 @@ openedx_tagging/core/tagging/migrations/0012_language_taxonomy.py
90
92
  openedx_tagging/core/tagging/migrations/0013_tag_parent_blank.py
91
93
  openedx_tagging/core/tagging/migrations/0014_minor_fixes.py
92
94
  openedx_tagging/core/tagging/migrations/0015_taxonomy_export_id.py
95
+ openedx_tagging/core/tagging/migrations/0016_object_tag_export_id.py
93
96
  openedx_tagging/core/tagging/migrations/__init__.py
94
97
  openedx_tagging/core/tagging/models/__init__.py
95
98
  openedx_tagging/core/tagging/models/base.py
{openedx-learning-0.6.2 → openedx-learning-0.8.0}/openedx_tagging/core/tagging/admin.py RENAMED
@@ -34,7 +34,7 @@ class ObjectTagAdmin(admin.ModelAdmin):
34
34
  """
35
35
  fields = ["object_id", "taxonomy", "tag", "_value"]
36
36
  autocomplete_fields = ["tag"]
37
- list_display = ["object_id", "name", "value"]
37
+ list_display = ["object_id", "export_id", "value"]
38
38
  readonly_fields = ["object_id"]
39
39
 
40
40
  def has_add_permission(self, request):