platform-plugin-aspects 1.3.0__tar.gz → 2.0.1__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 (97) hide show
  1. platform_plugin_aspects-2.0.1/.annotation_safe_list.yml +41 -0
  2. platform_plugin_aspects-2.0.1/.editorconfig +100 -0
  3. platform_plugin_aspects-2.0.1/.pii_annotations.yml +35 -0
  4. platform_plugin_aspects-2.0.1/.readthedocs.yaml +24 -0
  5. platform_plugin_aspects-2.0.1/MANIFEST.in +10 -0
  6. {platform_plugin_aspects-1.3.0/platform_plugin_aspects.egg-info → platform_plugin_aspects-2.0.1}/PKG-INFO +14 -24
  7. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1}/README.rst +5 -4
  8. platform_plugin_aspects-2.0.1/catalog-info.yaml +25 -0
  9. platform_plugin_aspects-2.0.1/codecov.yml +12 -0
  10. platform_plugin_aspects-2.0.1/manage.py +29 -0
  11. platform_plugin_aspects-2.0.1/pylintrc +391 -0
  12. platform_plugin_aspects-2.0.1/pylintrc_tweaks +14 -0
  13. platform_plugin_aspects-2.0.1/pyproject.toml +171 -0
  14. platform_plugin_aspects-2.0.1/setup.cfg +4 -0
  15. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/__init__.py +2 -1
  16. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/babel_mako.cfg +10 -0
  17. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/config.yaml +85 -0
  18. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/en/LC_MESSAGES/django.mo +0 -0
  19. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/en/LC_MESSAGES/django.po +99 -0
  20. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/en/LC_MESSAGES/mako.mo +0 -0
  21. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/en/LC_MESSAGES/mako.po +23 -0
  22. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/eo/LC_MESSAGES/django.mo +0 -0
  23. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/eo/LC_MESSAGES/django.po +70 -0
  24. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/eo/LC_MESSAGES/mako.mo +0 -0
  25. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/conf/locale/eo/LC_MESSAGES/mako.po +23 -0
  26. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/extensions/tests/test_filters.py +124 -0
  27. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/management/commands/dump_data_to_clickhouse.py +7 -0
  28. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/settings/__init__.py +0 -0
  29. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/settings/common.py +3 -3
  30. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/settings/tests/__init__.py +0 -0
  31. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_base_sink.py +298 -0
  32. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_course_enrollment_sink.py +20 -0
  33. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_course_overview_sink.py +415 -0
  34. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_external_id_sink.py +22 -0
  35. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_serializers.py +96 -0
  36. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_user_profile_sink.py +20 -0
  37. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/sinks/tests/test_user_retire_sink.py +106 -0
  38. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/__init__.py +0 -0
  39. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/commands/test_dump_data_to_clickhouse.py +267 -0
  40. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/commands/test_load_test_monitor.py +154 -0
  41. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/commands/test_load_test_tracking_events.py +110 -0
  42. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/test_signals.py +59 -0
  43. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/test_tasks.py +59 -0
  44. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/test_utils.py +294 -0
  45. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/test_views.py +493 -0
  46. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/tests/test_xblock.py +226 -0
  47. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/views.py +3 -18
  48. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/xblock.py +18 -0
  49. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src/platform_plugin_aspects.egg-info}/PKG-INFO +14 -24
  50. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects.egg-info/SOURCES.txt +88 -0
  51. platform_plugin_aspects-2.0.1/src/platform_plugin_aspects.egg-info/scm_file_list.json +115 -0
  52. platform_plugin_aspects-2.0.1/test_settings.py +132 -0
  53. platform_plugin_aspects-2.0.1/test_utils/__init__.py +10 -0
  54. platform_plugin_aspects-2.0.1/test_utils/helpers.py +390 -0
  55. platform_plugin_aspects-2.0.1/uv.lock +2647 -0
  56. platform_plugin_aspects-1.3.0/MANIFEST.in +0 -5
  57. platform_plugin_aspects-1.3.0/platform_plugin_aspects.egg-info/SOURCES.txt +0 -49
  58. platform_plugin_aspects-1.3.0/platform_plugin_aspects.egg-info/not-zip-safe +0 -1
  59. platform_plugin_aspects-1.3.0/requirements/base.in +0 -19
  60. platform_plugin_aspects-1.3.0/requirements/constraints.txt +0 -14
  61. platform_plugin_aspects-1.3.0/setup.cfg +0 -16
  62. platform_plugin_aspects-1.3.0/setup.py +0 -187
  63. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1}/LICENSE +0 -0
  64. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/apps.py +0 -0
  65. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/extensions/__init__.py +0 -0
  66. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/extensions/filters.py +0 -0
  67. {platform_plugin_aspects-1.3.0/platform_plugin_aspects/management → platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/extensions/tests}/__init__.py +0 -0
  68. {platform_plugin_aspects-1.3.0/platform_plugin_aspects/management/commands → platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/management}/__init__.py +0 -0
  69. {platform_plugin_aspects-1.3.0/platform_plugin_aspects/settings → platform_plugin_aspects-2.0.1/src/platform_plugin_aspects/management/commands}/__init__.py +0 -0
  70. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/management/commands/load_test_tracking_events.py +0 -0
  71. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/management/commands/monitor_load_test_tracking.py +0 -0
  72. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/settings/production.py +0 -0
  73. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/signals.py +0 -0
  74. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/__init__.py +0 -0
  75. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/base_sink.py +0 -0
  76. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/course_enrollment_sink.py +0 -0
  77. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/course_overview_sink.py +0 -0
  78. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/external_id_sink.py +0 -0
  79. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/serializers.py +0 -0
  80. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/tag_sink.py +0 -0
  81. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/user_profile_sink.py +0 -0
  82. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/sinks/user_retire_sink.py +0 -0
  83. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/css/superset.css +0 -0
  84. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/html/superset.html +0 -0
  85. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/html/superset_student.html +0 -0
  86. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/js/embed_dashboard.js +0 -0
  87. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/js/install_required.js +0 -0
  88. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/static/js/superset.js +0 -0
  89. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/tasks.py +0 -0
  90. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/templates/instructor_dashboard/aspects.html +0 -0
  91. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/urls.py +0 -0
  92. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/utils.py +0 -0
  93. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects/waffle.py +0 -0
  94. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects.egg-info/dependency_links.txt +0 -0
  95. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects.egg-info/entry_points.txt +0 -0
  96. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects.egg-info/requires.txt +2 -2
  97. {platform_plugin_aspects-1.3.0 → platform_plugin_aspects-2.0.1/src}/platform_plugin_aspects.egg-info/top_level.txt +0 -0
@@ -0,0 +1,41 @@
1
+ # This is a Code Annotations automatically-generated Django model safelist file.
2
+ # These models must be annotated as follows in order to be counted in the coverage report.
3
+ # See https://code-annotations.readthedocs.io/en/latest/safelist.html for more information.
4
+ #
5
+ # fake_app_1.FakeModelName:
6
+ # ".. no_pii:": "This model has no PII"
7
+ # fake_app_2.FakeModel2:
8
+ # ".. choice_annotation:": foo, bar, baz
9
+
10
+ admin.LogEntry:
11
+ ".. no_pii:": "This model has no PII"
12
+ auth.Group:
13
+ ".. no_pii:": "This model has no PII"
14
+ auth.Permission:
15
+ ".. no_pii:": "This model has no PII"
16
+ auth.User:
17
+ ".. pii": "This model minimally contains a username, password, and email"
18
+ ".. pii_types": "username, email_address, password"
19
+ ".. pii_retirement": "consumer_api"
20
+ contenttypes.ContentType:
21
+ ".. no_pii:": "This model has no PII"
22
+ sessions.Session:
23
+ ".. no_pii:": "This model has no PII"
24
+ social_django.Association:
25
+ ".. no_pii:": "This model has no PII"
26
+ social_django.Code:
27
+ ".. pii:": "Email address"
28
+ ".. pii_types:": other
29
+ ".. pii_retirement:": local_api
30
+ social_django.Nonce:
31
+ ".. no_pii:": "This model has no PII"
32
+ social_django.Partial:
33
+ ".. no_pii:": "This model has no PII"
34
+ social_django.UserSocialAuth:
35
+ ".. no_pii:": "This model has no PII"
36
+ waffle.Flag:
37
+ ".. no_pii:": "This model has no PII"
38
+ waffle.Sample:
39
+ ".. no_pii:": "This model has no PII"
40
+ waffle.Switch:
41
+ ".. no_pii:": "This model has no PII"
@@ -0,0 +1,100 @@
1
+ # ***************************
2
+ # ** DO NOT EDIT THIS FILE **
3
+ # ***************************
4
+ #
5
+ # This file was generated by edx-lint: https://github.com/openedx/edx-lint
6
+ #
7
+ # If you want to change this file, you have two choices, depending on whether
8
+ # you want to make a local change that applies only to this repo, or whether
9
+ # you want to make a central change that applies to all repos using edx-lint.
10
+ #
11
+ # Note: If your .editorconfig file is simply out-of-date relative to the latest
12
+ # .editorconfig in edx-lint, ensure you have the latest edx-lint installed
13
+ # and then follow the steps for a "LOCAL CHANGE".
14
+ #
15
+ # LOCAL CHANGE:
16
+ #
17
+ # 1. Edit the local .editorconfig_tweaks file to add changes just to this
18
+ # repo's file.
19
+ #
20
+ # 2. Run:
21
+ #
22
+ # $ edx_lint write .editorconfig
23
+ #
24
+ # 3. This will modify the local file. Submit a pull request to get it
25
+ # checked in so that others will benefit.
26
+ #
27
+ #
28
+ # CENTRAL CHANGE:
29
+ #
30
+ # 1. Edit the .editorconfig file in the edx-lint repo at
31
+ # https://github.com/openedx/edx-lint/blob/master/edx_lint/files/.editorconfig
32
+ #
33
+ # 2. install the updated version of edx-lint (in edx-lint):
34
+ #
35
+ # $ pip install .
36
+ #
37
+ # 3. Run (in edx-lint):
38
+ #
39
+ # $ edx_lint write .editorconfig
40
+ #
41
+ # 4. Make a new version of edx_lint, submit and review a pull request with the
42
+ # .editorconfig update, and after merging, update the edx-lint version and
43
+ # publish the new version.
44
+ #
45
+ # 5. In your local repo, install the newer version of edx-lint.
46
+ #
47
+ # 6. Run:
48
+ #
49
+ # $ edx_lint write .editorconfig
50
+ #
51
+ # 7. This will modify the local file. Submit a pull request to get it
52
+ # checked in so that others will benefit.
53
+ #
54
+ #
55
+ #
56
+ #
57
+ #
58
+ # STAY AWAY FROM THIS FILE!
59
+ #
60
+ #
61
+ #
62
+ #
63
+ #
64
+ # SERIOUSLY.
65
+ #
66
+ # ------------------------------
67
+ # Generated by edx-lint version: 5.2.5
68
+ # ------------------------------
69
+ [*]
70
+ end_of_line = lf
71
+ insert_final_newline = true
72
+ charset = utf-8
73
+ indent_style = space
74
+ indent_size = 4
75
+ max_line_length = 120
76
+ trim_trailing_whitespace = true
77
+
78
+ [{Makefile, *.mk}]
79
+ indent_style = tab
80
+ indent_size = 8
81
+
82
+ [*.{yml,yaml,json}]
83
+ indent_size = 2
84
+
85
+ [*.js]
86
+ indent_size = 2
87
+
88
+ [*.diff]
89
+ trim_trailing_whitespace = false
90
+
91
+ [.git/*]
92
+ trim_trailing_whitespace = false
93
+
94
+ [COMMIT_EDITMSG]
95
+ max_line_length = 72
96
+
97
+ [*.rst]
98
+ max_line_length = 79
99
+
100
+ # f2f02689fced7a2e0c62c2f9803184114dc2ae4b
@@ -0,0 +1,35 @@
1
+ source_path: ./
2
+ report_path: pii_report
3
+ safelist_path: .annotation_safe_list.yml
4
+ coverage_target: 100.0
5
+ annotations:
6
+ ".. no_pii:":
7
+ "pii_group":
8
+ - ".. pii:":
9
+ - ".. pii_types:":
10
+ choices:
11
+ - id # Unique identifier for the user which is shared across systems
12
+ - name # Used for any part of the user's name
13
+ - username
14
+ - password
15
+ - location # Used for any part of any type address or country stored
16
+ - phone_number # Used for phone or fax numbers
17
+ - email_address
18
+ - birth_date # Used for any part of a stored birth date
19
+ - ip # IP address
20
+ - external_service # Used for external service ids or links such as social media links or usernames, website links, etc.
21
+ - biography # Any type of free-form biography field
22
+ - gender
23
+ - sex
24
+ - image
25
+ - video
26
+ - other
27
+ - ".. pii_retirement:":
28
+ choices:
29
+ - retained # Intentionally kept for legal reasons
30
+ - local_api # An API exists in this repository for retiring this information
31
+ - consumer_api # The data's consumer must implement an API for retiring this information
32
+ - third_party # A third party API exists to retire this data
33
+ extensions:
34
+ python:
35
+ - py
@@ -0,0 +1,24 @@
1
+ # .readthedocs.yml
2
+ # Read the Docs configuration file
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+ # Required
6
+ version: 2
7
+
8
+ # Build documentation in the docs/ directory with Sphinx
9
+ sphinx:
10
+ configuration: docs/conf.py
11
+ fail_on_warning: false
12
+
13
+ # Set the version of python needed to build these docs.
14
+ build:
15
+ os: "ubuntu-lts-latest"
16
+ tools:
17
+ python: "3.12"
18
+
19
+ python:
20
+ install:
21
+ - method: uv
22
+ command: sync
23
+ groups:
24
+ - doc
@@ -0,0 +1,10 @@
1
+ # Exclude development, test, and documentation folders
2
+ prune .github
3
+ prune docs
4
+ prune tests
5
+
6
+ # Exclude root level configuration and build files
7
+ exclude Makefile
8
+ exclude conftest.py
9
+ exclude .gitignore
10
+ exclude tox.ini
@@ -1,26 +1,24 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: platform-plugin-aspects
3
- Version: 1.3.0
3
+ Version: 2.0.1
4
4
  Summary: Aspects plugins for edx-platform
5
- Home-page: https://github.com/openedx/platform-plugin-aspects
6
- Author: Open edX Project
7
- Author-email: oscm@openedx.org
8
- License: Apache 2.0
9
- Keywords: Python edx
5
+ Author-email: Open edX Project <oscm@openedx.org>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/openedx/platform-plugin-aspects
8
+ Project-URL: Repository, https://github.com/openedx/platform-plugin-aspects
9
+ Keywords: Python,edx
10
10
  Classifier: Development Status :: 3 - Alpha
11
11
  Classifier: Framework :: Django
12
- Classifier: Framework :: Django :: 4.2
13
12
  Classifier: Framework :: Django :: 5.2
14
13
  Classifier: Intended Audience :: Developers
15
- Classifier: License :: OSI Approved :: Apache Software License
16
14
  Classifier: Natural Language :: English
17
15
  Classifier: Programming Language :: Python :: 3
18
16
  Classifier: Programming Language :: Python :: 3.12
19
17
  Requires-Python: >=3.12
18
+ Description-Content-Type: text/x-rst
20
19
  License-File: LICENSE
21
- Requires-Dist: Django
22
- Requires-Dist: XBlock
23
20
  Requires-Dist: celery
21
+ Requires-Dist: Django
24
22
  Requires-Dist: django_crum
25
23
  Requires-Dist: djangorestframework
26
24
  Requires-Dist: edx-django-utils
@@ -33,17 +31,8 @@ Requires-Dist: redis
33
31
  Requires-Dist: requests
34
32
  Requires-Dist: superset-api-client
35
33
  Requires-Dist: web_fragments
36
- Dynamic: author
37
- Dynamic: author-email
38
- Dynamic: classifier
39
- Dynamic: description
40
- Dynamic: home-page
41
- Dynamic: keywords
42
- Dynamic: license
34
+ Requires-Dist: XBlock
43
35
  Dynamic: license-file
44
- Dynamic: requires-dist
45
- Dynamic: requires-python
46
- Dynamic: summary
47
36
 
48
37
  Platform Plugin Aspects
49
38
  #######################
@@ -260,10 +249,11 @@ Event Sink Configuration
260
249
  - ``module`` - The module path of the model.
261
250
  - ``model`` - The model class name.
262
251
 
263
- Event Sinks are disabled by default. To enable them, you need to enable the following
264
- waffle flag: ``event_sink_clickhouse.{{model_name}}.enabled``, where model_name is the name
265
- of the model that you want to enable. Or, you can enable them via settings by setting
266
- ``EVENT_SINK_CLICKHOUSE_{{model_name}}_ENABLED`` to ``True``.
252
+ Event Sinks are disabled by default from this repository, but enabled in the Aspects Tutor
253
+ plugin (tutor-contrib-aspects). If not using the Tutor plugin you will need to enable the
254
+ following waffle flags: ``event_sink_clickhouse.{{model_name}}.enabled``, where model_name
255
+ is the name of the model that you want to enable. Or, you can enable them via settings by
256
+ setting ``EVENT_SINK_CLICKHOUSE_{{model_name}}_ENABLED`` to ``True``.
267
257
 
268
258
 
269
259
  Getting Help
@@ -213,10 +213,11 @@ Event Sink Configuration
213
213
  - ``module`` - The module path of the model.
214
214
  - ``model`` - The model class name.
215
215
 
216
- Event Sinks are disabled by default. To enable them, you need to enable the following
217
- waffle flag: ``event_sink_clickhouse.{{model_name}}.enabled``, where model_name is the name
218
- of the model that you want to enable. Or, you can enable them via settings by setting
219
- ``EVENT_SINK_CLICKHOUSE_{{model_name}}_ENABLED`` to ``True``.
216
+ Event Sinks are disabled by default from this repository, but enabled in the Aspects Tutor
217
+ plugin (tutor-contrib-aspects). If not using the Tutor plugin you will need to enable the
218
+ following waffle flags: ``event_sink_clickhouse.{{model_name}}.enabled``, where model_name
219
+ is the name of the model that you want to enable. Or, you can enable them via settings by
220
+ setting ``EVENT_SINK_CLICKHOUSE_{{model_name}}_ENABLED`` to ``True``.
220
221
 
221
222
 
222
223
  Getting Help
@@ -0,0 +1,25 @@
1
+ # This file records information about this repo. Its use is described in OEP-55:
2
+ # https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html
3
+
4
+ apiVersion: backstage.io/v1alpha1
5
+ kind: "Component"
6
+ metadata:
7
+ name: 'platform-plugin-aspects'
8
+ description: "Aspects plugins for edx-platform"
9
+ annotations:
10
+ # (Optional) Annotation keys and values can be whatever you want.
11
+ # We use it in Open edX repos to have a comma-separated list of GitHub user
12
+ # names that might be interested in changes to the architecture of this
13
+ # component.
14
+ openedx.org/arch-interest-groups: ""
15
+ openedx.org/release: "main"
16
+ spec:
17
+
18
+ # (Required) This can be a group(`group:<group_name>` or a user(`user:<github_username>`)
19
+ owner: group:committers-analytics
20
+
21
+ # (Required) Acceptable Type Values: service, website, library
22
+ type: 'library'
23
+
24
+ # (Required) Acceptable Lifecycle Values: experimental, production, deprecated
25
+ lifecycle: 'production'
@@ -0,0 +1,12 @@
1
+ coverage:
2
+ status:
3
+ project:
4
+ default:
5
+ enabled: yes
6
+ target: auto
7
+ patch:
8
+ default:
9
+ enabled: yes
10
+ target: 100%
11
+
12
+ comment: false
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env python
2
+ """
3
+ Django administration utility.
4
+ """
5
+
6
+ import os
7
+ import sys
8
+
9
+ PWD = os.path.abspath(os.path.dirname(__file__))
10
+
11
+ if __name__ == "__main__":
12
+ os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_settings")
13
+ sys.path.append(PWD)
14
+ try:
15
+ from django.core.management import execute_from_command_line
16
+ except ImportError:
17
+ # The above import may fail for some other reason. Ensure that the
18
+ # issue is really that Django is missing to avoid masking other
19
+ # exceptions on Python 2.
20
+ try:
21
+ import django # pylint: disable=unused-import
22
+ except ImportError as import_error:
23
+ raise ImportError(
24
+ "Couldn't import Django. Are you sure it's installed and "
25
+ "available on your PYTHONPATH environment variable? Did you "
26
+ "forget to activate a virtual environment?"
27
+ ) from import_error
28
+ raise
29
+ execute_from_command_line(sys.argv)