Django-SupportTools 3.6.4__py3-none-any.whl → 4.0.dev3__py3-none-any.whl

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 (27) hide show
  1. {django_supporttools-3.6.4.dist-info → django_supporttools-4.0.dev3.dist-info}/METADATA +2 -2
  2. {django_supporttools-3.6.4.dist-info → django_supporttools-4.0.dev3.dist-info}/RECORD +27 -18
  3. {django_supporttools-3.6.4.dist-info → django_supporttools-4.0.dev3.dist-info}/WHEEL +1 -1
  4. supporttools/VERSION +1 -1
  5. supporttools/context_processors.py +191 -2
  6. supporttools/static/supporttools/css/bootstrap-icons.woff +0 -0
  7. supporttools/static/supporttools/css/bootstrap-icons.woff2 +0 -0
  8. supporttools/static/supporttools/css/desktop.less +37 -23
  9. supporttools/static/supporttools/css/main.css +1 -0
  10. supporttools/static/supporttools/css/mobile.less +5 -0
  11. supporttools/static/supporttools/js/main.js +1 -284
  12. supporttools/static/supporttools/js/restclients.js +251 -0
  13. supporttools/templates/restclients/proxy_wrapper.html +5 -0
  14. supporttools/templates/supporttools/base.html +59 -8
  15. supporttools/templates/supporttools/spa_tool.html +17 -0
  16. supporttools/templatetags/sidebar_links.py +3 -3
  17. supporttools/templatetags/vite.py +99 -0
  18. supporttools/tests/__init__.py +4 -3
  19. supporttools/tests/test_context_processors.py +132 -4
  20. supporttools/tests/test_sidebar_links.py +2 -2
  21. supporttools/tests/test_templatetags_vite.py +165 -0
  22. supporttools/tests/test_urls.py +66 -0
  23. supporttools/tests/test_views.py +114 -0
  24. supporttools/urls.py +58 -2
  25. supporttools/views.py +29 -1
  26. {django_supporttools-3.6.4.dist-info → django_supporttools-4.0.dev3.dist-info}/licenses/LICENSE +0 -0
  27. {django_supporttools-3.6.4.dist-info → django_supporttools-4.0.dev3.dist-info}/top_level.txt +0 -0
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: Django-SupportTools
3
- Version: 3.6.4
3
+ Version: 4.0.dev3
4
4
  Summary: A Django application used for theming and wrapping support tools.
5
5
  Home-page: https://github.com/uw-it-aca/django-supporttools
6
- Author: UW-IT Student & Educational Technology Services
6
+ Author: UWIT Student & Educational Technology Services
7
7
  Author-email: aca-it@uw.edu
8
8
  License: Apache License, Version 2.0
9
9
  Classifier: Intended Audience :: Developers
@@ -1,13 +1,17 @@
1
- django_supporttools-3.6.4.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
2
- supporttools/VERSION,sha256=mpievZXv4zT0JI2x1jQy6qB-b74OEjTkfJHl_IiQbKE,6
1
+ django_supporttools-4.0.dev3.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
2
+ supporttools/VERSION,sha256=lT4lpnSTfctrTtzEfZtEPNUgAbP2oxhOHCIQ2fM1CO4,8
3
3
  supporttools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
- supporttools/context_processors.py,sha256=Xjpe03BpmVjvd8mMM1hVGz5Zw3AAqIqcILSa8dq8V20,1353
5
- supporttools/urls.py,sha256=BkP1UZaDPs4NewpsLt040AXAP-2hmeq7kmGf-h5ngQ0,245
6
- supporttools/views.py,sha256=ASeaUaS23iARRd_xGW5QHnzgzI2KOF-qQ42D0Ig208c,212
4
+ supporttools/context_processors.py,sha256=zcnqAyHAlAxT-7MvUjiW34sPOqK_aEv7pjNQ2G7M2Io,7766
5
+ supporttools/urls.py,sha256=Xq4gS_Y3PKsrZWmsUfWzThJDyoi8V2toF2Zwpv34T3Q,2335
6
+ supporttools/views.py,sha256=M5QwzPy35Vz3ylYATwoWmchRFOIJlFRBfu9nS1RXtQ4,1093
7
7
  supporttools/static/supporttools/css/.DS_Store,sha256=1lFlJ5EFymdzGAUAaI30vcaaLHt3F1LwpG7xILf9jsM,6148
8
- supporttools/static/supporttools/css/desktop.less,sha256=xGAZcHrVeyveR_SV9ojWoLT8fA3eagFl9oOE5Ag1UxY,1822
9
- supporttools/static/supporttools/css/mobile.less,sha256=BtT5h9KvndMJahK_Osi4lJaP2IAYKmOB5eSrsGbrQic,6616
10
- supporttools/static/supporttools/js/main.js,sha256=KtkMsJ4LrAx_Ls5e_NuoSmdeGVNsN56KnxL0bEI6Ilc,9542
8
+ supporttools/static/supporttools/css/bootstrap-icons.woff,sha256=9VUTt7WRy4SjuH_w406iTUgx1v7cIuVLkRymS1tUShU,180288
9
+ supporttools/static/supporttools/css/bootstrap-icons.woff2,sha256=bHVxA2ShylYEJncW9tKJl7JjGf2weM8R4LQqtm_y6mE,134044
10
+ supporttools/static/supporttools/css/desktop.less,sha256=ONEMjkZcjXig5c83DCUw7xq2CZpRIb8LUVgEmS-psY4,2063
11
+ supporttools/static/supporttools/css/main.css,sha256=YgEfws8KqARHL0I1kGAumFt9wv6OOch1TlmhMD2GXKU,465217
12
+ supporttools/static/supporttools/css/mobile.less,sha256=wSrRwU9ozGXsymNXBOXkmPEevI06vWfi43rTPX4xBzM,6784
13
+ supporttools/static/supporttools/js/main.js,sha256=dZpzsR3SiG55HAzxDaIRcsuU90SEwzHLyyVoyfMRLvE,65706
14
+ supporttools/static/supporttools/js/restclients.js,sha256=9Lwq0BLaSMtw9jpX_ahe20IFlbc_45kFuszDgCZmhu8,8258
11
15
  supporttools/static/uw/ico/android-196x196.png,sha256=fwIqQqRNVnPQ9uBb--JuWUQuZxDaIDR4_iMTev_d3rQ,30590
12
16
  supporttools/static/uw/ico/apple-touch-icon-114x114-precomposed.png,sha256=DY2jTScazo0xCCYcgG0plyH5qybYphJ4DFm62l2bFKk,9632
13
17
  supporttools/static/uw/ico/apple-touch-icon-120x120-precomposed.png,sha256=C7AYjSCmtWpyKTFtG2QsYfUBppeWWApsYyfZv_mtcqQ,4752
@@ -39,19 +43,24 @@ supporttools/static/vendor/js/chart.min.js,sha256=g1Um5FM1tnBn0J_vSHa-tG9lV6NXzW
39
43
  supporttools/static/vendor/js/jquery-1.10.2.min.js,sha256=C6CB9UYIS9UJeqinPHWTHVqh_E1uhG5Twh-Y5qFQmYg,93107
40
44
  supporttools/static/vendor/js/less-1.7.0.min.js,sha256=lRUhz5h55etTShQEO68H7kghqa1iy5kPi2UZGur5jzI,101854
41
45
  supporttools/templates/persistent_message/manage_wrapper.html,sha256=cDCHhNPE5JvKQWMBBK-FCT1CA3PO5GtzLXSY8_bnSHk,40
42
- supporttools/templates/restclients/proxy_wrapper.html,sha256=cDCHhNPE5JvKQWMBBK-FCT1CA3PO5GtzLXSY8_bnSHk,40
46
+ supporttools/templates/restclients/proxy_wrapper.html,sha256=0kD1QSWJ0pO8OCgoQyln83NNef1mVspUMEnKYntr3zE,165
43
47
  supporttools/templates/status_app/status_wrapper.html,sha256=6SrRiFpsTe7JSOvQGYKwJTL9dsoFGKe5CGPe45bcrFA,38
44
- supporttools/templates/supporttools/base.html,sha256=RY2GySXo70sPrEy9ZbHt1mPsncSD6b1URdlP89PMc28,8533
48
+ supporttools/templates/supporttools/base.html,sha256=GFSSwTetujqagazAemZoIASFm0_2qsNX9xNW2ss5irg,10784
45
49
  supporttools/templates/supporttools/default_sidelinks.html,sha256=lx5Kg32rrbJQpHGi8lAOiqQsn-k8w9Ams03VaA1Ieb0,1550
46
50
  supporttools/templates/supporttools/home.html,sha256=nHb9UN-xplfkRYBwgEVZCj1vZFc0e0CmSEuowvZmcaI,810
51
+ supporttools/templates/supporttools/spa_tool.html,sha256=RLkawzvzRUuc_dVJ0EOdk7v5Gt_syI1FIyG3jTv6lGA,485
47
52
  supporttools/templates/userservice/user_override_wrapper.html,sha256=6SrRiFpsTe7JSOvQGYKwJTL9dsoFGKe5CGPe45bcrFA,38
48
53
  supporttools/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
49
- supporttools/templatetags/sidebar_links.py,sha256=WLji7kaYoKeqO5wC117LJYutuyleUyccpdFKVTkh-gA,690
50
- supporttools/tests/__init__.py,sha256=4cljV5gSQIWw7wCKOmJJW2KWQd4YaZTNkOsQtqwSdgY,552
51
- supporttools/tests/test_context_processors.py,sha256=5f6G_smx34S5LE9pJ3Ei-K48lvsfMoFKlUbvbh8l7jg,4048
52
- supporttools/tests/test_sidebar_links.py,sha256=oF5bzVmiTa5mG-1jXSe4cJ7rCFLW2Ou387wrGuLZDfo,1090
54
+ supporttools/templatetags/sidebar_links.py,sha256=9qz5fLWpkzsLnEdAzDAYZPd9j17fyTgxL5DjZlZvEEo,674
55
+ supporttools/templatetags/vite.py,sha256=OKrKEnLaCSnniY49kneUDCkDia0AL45u6mN-JC9HuK8,2627
56
+ supporttools/tests/__init__.py,sha256=adV6bn3fdiUwY7UT1yJfpaLpg2RK9x9-loKquNPp0Gs,567
57
+ supporttools/tests/test_context_processors.py,sha256=Qi6tREet7rnkL-2mTLT8HOi-JUZLzsl-zF7XtDV-duY,9540
58
+ supporttools/tests/test_sidebar_links.py,sha256=swTWe6daBjby4byHQKvi7j47kdniQQq6HQf4KVCLzEU,1090
59
+ supporttools/tests/test_templatetags_vite.py,sha256=eGoxGVCQ6t6Jh072Hj9TwAY1_jH_hVxFn7uebQzE2jw,6678
60
+ supporttools/tests/test_urls.py,sha256=j-NjFF4bqhomd7Z-twsLDMCKB0bnOJmw_5uXL8FMZBI,2409
61
+ supporttools/tests/test_views.py,sha256=eSTX58fxE5vLpsu1RY9A6ElPhYZWTsqbl4NDuqPWA_Q,4178
53
62
  supporttools/tests/test_templates/supporttools/custom_sidebar_links.html,sha256=j006pbOiKeh7mAhR3m_qP3lrh784xGu_hXHz1TStGD4,158
54
- django_supporttools-3.6.4.dist-info/METADATA,sha256=h0mtx3doau5aZDmwaz6JUTBBv2PWHKXXbUqtzSvhrJ0,914
55
- django_supporttools-3.6.4.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
56
- django_supporttools-3.6.4.dist-info/top_level.txt,sha256=VMMbBdeXjJytNutORR9mBCBBK6mgNoBZZYspkSNmbkU,13
57
- django_supporttools-3.6.4.dist-info/RECORD,,
63
+ django_supporttools-4.0.dev3.dist-info/METADATA,sha256=cssDH8IKiJguP0N9bXEprHgKTIwiNj9J4phos2lwJvM,916
64
+ django_supporttools-4.0.dev3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
65
+ django_supporttools-4.0.dev3.dist-info/top_level.txt,sha256=VMMbBdeXjJytNutORR9mBCBBK6mgNoBZZYspkSNmbkU,13
66
+ django_supporttools-4.0.dev3.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.7.1)
2
+ Generator: setuptools (84.0.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
supporttools/VERSION CHANGED
@@ -1 +1 @@
1
- 3.6.4
1
+ 4.0dev3
@@ -1,13 +1,188 @@
1
- # Copyright 2025 UW-IT, University of Washington
1
+ # Copyright 2026 UW-IT, University of Washington
2
2
  # SPDX-License-Identifier: Apache-2.0
3
3
 
4
+ import logging
5
+
4
6
  from django.conf import settings
7
+ from django.urls import NoReverseMatch, reverse
5
8
  from userservice.user import UserService
6
9
 
10
+ logger = logging.getLogger(__name__)
11
+
12
+
13
+ def normalize_mode_fields(entry):
14
+ # Treat entries with SPA markers as converted tools, even if mode is
15
+ # omitted. Legacy server tools do not include these fields.
16
+ is_converted = any(
17
+ entry.get(key) for key in ("route", "component_key", "vite_entry")
18
+ )
19
+ mode = entry.get("mode", "server")
20
+ if mode not in {"server", "spa"}:
21
+ mode = "server"
22
+ if is_converted:
23
+ mode = "spa"
24
+
25
+ route = entry.get("route")
26
+ component_key = entry.get("component_key")
27
+ # Converted tools are SPA-only; full reload is not supported for them.
28
+ requires_full_reload = False
29
+
30
+ # A SPA entry must declare both route and component_key. Converted tools
31
+ # that fail this contract are dropped from the Vue registry.
32
+ if mode == "spa" and not (route and component_key):
33
+ logger.warning(
34
+ "Skipping invalid SPA supporttools registry entry %r: "
35
+ "route and component_key are required for converted tools.",
36
+ entry.get("id") or entry.get("url_name") or entry.get("label"),
37
+ )
38
+ return None
39
+
40
+ return {
41
+ "mode": mode,
42
+ "route": route,
43
+ "component_key": component_key,
44
+ "requires_full_reload": requires_full_reload,
45
+ }
46
+
47
+
48
+ def _resolve_url(url_name, url_args=None, url_kwargs=None):
49
+ try:
50
+ return reverse(url_name, args=url_args or (), kwargs=url_kwargs or {})
51
+ except NoReverseMatch:
52
+ return None
53
+
54
+
55
+ def _default_view_registry(request):
56
+ entries = []
57
+ defaults = [
58
+ (10, "Support Home", "supporttools_home"),
59
+ (20, "User Override", "userservice_override"),
60
+ (30, "Status", "status_app.views.status"),
61
+ (40, "Persistent Messages", "manage_persistent_messages"),
62
+ (50, "Browse Student Web Service", "restclients_proxy",
63
+ ("sws", "student/v5.json"), {}),
64
+ (60, "Browse Person Web Service", "restclients_proxy",
65
+ ("pws", "identity/v2.json"), {}),
66
+ ]
67
+
68
+ for row in defaults:
69
+ if len(row) == 3:
70
+ order, label, url_name = row
71
+ url_args = ()
72
+ url_kwargs = {}
73
+ else:
74
+ order, label, url_name, url_args, url_kwargs = row
75
+
76
+ url = _resolve_url(url_name, url_args=url_args, url_kwargs=url_kwargs)
77
+ if url:
78
+ entries.append({
79
+ "id": url_name,
80
+ "section": "general",
81
+ "order": order,
82
+ "label": label,
83
+ "url_name": url_name,
84
+ "url": url,
85
+ "url_args": list(url_args),
86
+ "url_kwargs": url_kwargs,
87
+ "mode": "server",
88
+ "route": None,
89
+ "component_key": None,
90
+ "requires_full_reload": False,
91
+ })
92
+
93
+ return entries
94
+
95
+
96
+ def _extra_views_registry(request):
97
+ entries = []
98
+ extra_views = getattr(settings, "SUPPORTTOOLS_EXTRA_VIEWS", {})
99
+
100
+ for label, url_name in extra_views.items():
101
+ url = _resolve_url(url_name)
102
+ if not url:
103
+ continue
104
+
105
+ entries.append({
106
+ "id": url_name,
107
+ "section": "application",
108
+ "order": 100,
109
+ "label": label,
110
+ "url_name": url_name,
111
+ "url": url,
112
+ "url_args": [],
113
+ "url_kwargs": {},
114
+ "mode": "server",
115
+ "route": None,
116
+ "component_key": None,
117
+ "requires_full_reload": False,
118
+ })
119
+
120
+ return entries
121
+
122
+
123
+ def _settings_view_registry(request):
124
+ entries = []
125
+ raw_registry = getattr(settings, "SUPPORTTOOLS_VIEW_REGISTRY", [])
126
+
127
+ for entry in raw_registry:
128
+ if not isinstance(entry, dict):
129
+ continue
130
+
131
+ label = entry.get("label")
132
+ url_name = entry.get("url_name")
133
+ if not label or not url_name:
134
+ continue
135
+
136
+ url_args = entry.get("url_args", [])
137
+ url_kwargs = entry.get("url_kwargs", {})
138
+ url = _resolve_url(url_name, url_args=url_args, url_kwargs=url_kwargs)
139
+ if not url:
140
+ continue
141
+
142
+ mode_fields = normalize_mode_fields(entry)
143
+ if not mode_fields:
144
+ continue
145
+ entries.append({
146
+ "id": entry.get("id") or url_name,
147
+ "section": entry.get("section") or "application",
148
+ "explicit": True,
149
+ "order": int(entry.get("order", 100)),
150
+ "label": label,
151
+ "url_name": url_name,
152
+ "url": url,
153
+ "url_args": list(url_args),
154
+ "url_kwargs": dict(url_kwargs),
155
+ **mode_fields,
156
+ })
157
+
158
+ return entries
159
+
160
+
161
+ def _effective_view_registry(request):
162
+ # Structured VIEW_REGISTRY (preferred) and legacy EXTRA_VIEWS are both
163
+ # always included so that enabling SUPPORTTOOLS_VUE_ENABLED alone is
164
+ # sufficient for apps that already have SUPPORTTOOLS_EXTRA_VIEWS set.
165
+ # VIEW_REGISTRY entries take precedence; duplicates are dropped by url_name.
166
+ structured = _settings_view_registry(request)
167
+ legacy = _extra_views_registry(request)
168
+
169
+ seen = {e["url_name"] for e in structured}
170
+ merged = structured + [e for e in legacy if e["url_name"] not in seen]
171
+
172
+ seen.update(e["url_name"] for e in merged)
173
+ defaults = _default_view_registry(request)
174
+ combined = [e for e in defaults if e["url_name"] not in seen] + merged
175
+ return sorted(combined, key=lambda e: (e["section"], e["order"],
176
+ e["label"].lower()))
177
+
7
178
 
8
179
  def supportools_globals(request):
180
+ user = UserService().get_original_user()
181
+ view_registry = _effective_view_registry(request)
182
+ user_agent = getattr(request, "user_agent", None)
183
+
9
184
  params = {
10
- "supporttools_user": UserService().get_original_user(),
185
+ "supporttools_user": user,
11
186
  "supporttools_parent_app": getattr(settings,
12
187
  "SUPPORTTOOLS_PARENT_APP", ""),
13
188
  "supporttools_parent_app_url": getattr(settings,
@@ -15,6 +190,20 @@ def supportools_globals(request):
15
190
  "/"),
16
191
  "supporttools_extra_views": getattr(settings,
17
192
  "SUPPORTTOOLS_EXTRA_VIEWS", {}),
193
+ "supporttools_vue_enabled": getattr(settings,
194
+ "SUPPORTTOOLS_VUE_ENABLED",
195
+ False),
196
+ "supporttools_view_registry": view_registry,
197
+ "supporttools_vue_context": {
198
+ "parent_app": getattr(settings, "SUPPORTTOOLS_PARENT_APP", ""),
199
+ "parent_app_url": getattr(settings,
200
+ "SUPPORTTOOLS_PARENT_APP_URL", "/"),
201
+ "user": user,
202
+ "is_mobile": bool(getattr(user_agent, "is_mobile", False)),
203
+ "is_tablet": bool(getattr(user_agent, "is_tablet", False)),
204
+ "is_desktop": bool(getattr(user_agent, "is_pc", False)),
205
+ "links": view_registry,
206
+ },
18
207
  }
19
208
  return (params)
20
209
 
@@ -19,34 +19,48 @@
19
19
  height: auto;
20
20
  width: 260px; max-width: 260px;
21
21
  margin-bottom: 0;
22
-
22
+
23
23
  /* inline media query for desktop */
24
24
  @media @desktop { width: 280px; max-width: 280px; }
25
-
25
+
26
26
  .header-inner {
27
-
27
+ position: absolute;
28
+ top: 0;
29
+ right: 0;
30
+ bottom: 65px;
31
+ left: 0;
32
+ display: flex;
33
+ flex-direction: column;
34
+
28
35
  .tool-app {}
29
-
30
- .tool-header {
31
- h1.tool-name {
32
-
33
- a { text-decoration: none;
36
+
37
+ .tool-header {
38
+ h1.tool-name {
39
+
40
+ a { text-decoration: none;
34
41
  &:hover { text-decoration: underline; }
35
42
  }
36
-
43
+
37
44
  }
38
45
  }
39
46
  .tool-list { background:none;
40
-
47
+ display: flex;
48
+ flex-direction: column;
49
+ flex: 1;
50
+ min-height: 0;
51
+ max-height: none;
52
+
41
53
  -moz-transition: 0;
42
54
  -ms-transition: 0;
43
55
  -o-transition: 0;
44
56
  -webkit-transition: 0;
45
57
  transition: 0;
46
-
47
- .tool-list-inner {
58
+
59
+ .tool-list-inner {
48
60
  margin: 0;
49
61
  margin-top: 20px;
62
+ flex: 1;
63
+ min-height: 0;
50
64
  overflow-y: auto;
51
65
  }
52
66
  }
@@ -55,33 +69,33 @@
55
69
  }
56
70
 
57
71
  .content {
58
-
72
+
59
73
  .content-inner { padding: 0 25px; }
60
74
  .container { }
61
-
75
+
62
76
  margin-right: auto;
63
77
  margin-left: 260px;
64
-
65
- @media @desktop {
78
+
79
+ @media @desktop {
66
80
  margin-left: 280px;
67
81
  }
68
-
82
+
69
83
  .navbar { margin: 1em 0; }
70
84
  }
71
85
 
72
86
 
73
87
  .footer { position: fixed; left: 0; bottom: 0; z-index: 100; margin: 0; border-top: solid 1px darken(@sidebar, 5%); width: 260px; padding: 15px 10px; height: 65px;
74
-
75
- @media @desktop {
76
- width: 280px;
88
+
89
+ @media @desktop {
90
+ width: 280px;
77
91
  }
78
-
92
+
79
93
  .footer-tagline { font-size: .85em; }
80
94
  }
81
95
 
82
96
 
83
- .user-service {
84
-
97
+ .user-service {
98
+
85
99
  position: absolute;
86
100
  top: 50%;
87
101
  margin-top: -80px;