csstweaks-client 0.1.0__py3-none-any.whl

csstweaks_client/urls.py

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from . import views
+
+app_name = 'csstweaks_client'
+
+urlpatterns = [
+    path('ping', views.ping, name='ping'),
+    path('read', views.read_file, name='read'),
+    path('write', views.write_file, name='write'),
+]

csstweaks_client/views.py

@@ -0,0 +1,85 @@
+"""Local-dev helper for the csstweaks browser extension.
+
+The extension reads and writes the CSS files Django's static finders resolve.
+Mount this only while debugging:
+
+    if settings.DEBUG:
+        urlpatterns += [path('__csstweaks__/', include('csstweaks_client.urls'))]
+
+Each view also refuses to run unless DEBUG is on.
+"""
+import json
+
+from django.conf import settings
+from django.contrib.staticfiles import finders
+from django.http import (
+    Http404,
+    HttpResponse,
+    HttpResponseBadRequest,
+    HttpResponseNotFound,
+    JsonResponse,
+)
+from django.views.decorators.csrf import csrf_exempt
+from django.views.decorators.http import require_GET, require_POST
+
+
+def _debug_only(view):
+    def wrapper(request, *args, **kwargs):
+        if not settings.DEBUG:
+            raise Http404()
+        return view(request, *args, **kwargs)
+    wrapper.__wrapped__ = view
+    return wrapper
+
+
+def _resolve(path):
+    """Map a STATIC_URL-relative path to a file via Django's static finders."""
+    if not path.lower().endswith('.css'):
+        return None
+
+    relative = path.lstrip('/')
+    static_url = settings.STATIC_URL.strip('/')
+    if static_url and relative.startswith(static_url + '/'):
+        relative = relative[len(static_url) + 1:]
+
+    return finders.find(relative)
+
+
+@_debug_only
+@require_GET
+def ping(request):
+    return JsonResponse({'ok': True, 'name': 'csstweaks-client'})
+
+
+@_debug_only
+@require_GET
+def read_file(request):
+    path = request.GET.get('path', '')
+    real_path = _resolve(path)
+    if not real_path:
+        return HttpResponseNotFound(f'no static CSS file resolves to {path!r}')
+    with open(real_path, 'r', encoding='utf-8') as handle:
+        return HttpResponse(handle.read(), content_type='text/css; charset=utf-8')
+
+
+@csrf_exempt
+@_debug_only
+@require_POST
+def write_file(request):
+    try:
+        body = json.loads(request.body)
+    except (ValueError, TypeError):
+        return HttpResponseBadRequest('invalid JSON body')
+
+    path = body.get('path', '')
+    content = body.get('content')
+    if not isinstance(content, str):
+        return HttpResponseBadRequest('missing content')
+
+    real_path = _resolve(path)
+    if not real_path:
+        return HttpResponseNotFound(f'no static CSS file resolves to {path!r}')
+
+    with open(real_path, 'w', encoding='utf-8') as handle:
+        handle.write(content)
+    return JsonResponse({'ok': True})

csstweaks_client-0.1.0.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: csstweaks-client
+Version: 0.1.0
+Summary: Django debug helper for the csstweaks browser extension
+Author: Vasudeva Server
+License-Expression: MIT
+Project-URL: Homepage, https://vasudevaserver.org
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.0,>=5.2
+Dynamic: license-file
+
+# csstweaks-client
+
+`csstweaks-client` is the Django companion to the csstweaks browser extension.
+It shortens the feedback loop for local CSS work: the extension reads the
+stylesheet currently served by Django, lets you adjust it in the browser, and
+writes the result back to the source file that Django's static-file finders
+resolve.
+
+This is a development helper, not a production editing API. Every view returns
+404 unless Django's `DEBUG` setting is enabled, and projects should mount its
+URLs only inside the same `DEBUG` check.
+
+## Install
+
+```sh
+pip install csstweaks-client
+```
+
+Add `csstweaks_client` to `INSTALLED_APPS`, then mount it in the project's root
+URL configuration:
+
+```python
+if settings.DEBUG:
+    urlpatterns += [path("__csstweaks__/", include("csstweaks_client.urls"))]
+```
+
+Start Django normally and connect the csstweaks extension to the development
+site. The client works with stylesheets found in a `STATICFILES_DIRS` directory
+or an installed app's `static/` directory.
+
+## Endpoints
+
+- `GET /__csstweaks__/ping` — the extension uses this to find the helper.
+- `GET /__csstweaks__/read?path=<STATIC_URL-relative path>` — returns raw CSS.
+- `POST /__csstweaks__/write` — `{"path": "...", "content": "..."}` overwrites the source file.
+
+For development of the client itself, install this checkout in editable mode:
+
+```sh
+pip install -e .
+```
+
+[Vasudeva Server](https://vasudevaserver.org)

csstweaks_client-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+csstweaks_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+csstweaks_client/urls.py,sha256=BMzxteZK60KeeyCpgFhC36d-ySOngA1Njo1N2w6vZCM,242
+csstweaks_client/views.py,sha256=9qpSaXOsi4Tf9UjATjx3b0olmmRSDLXr8Qy5tn8I4VM,2401
+csstweaks_client-0.1.0.dist-info/licenses/LICENSE,sha256=cjw5dL5wDMy6mDzC1e2pA6_73FVPaDJnoO1Nxmr582Q,1072
+csstweaks_client-0.1.0.dist-info/METADATA,sha256=AkKAEuFXyhWV5iJ-3-uPqqOZHCpvjyBLcKldAVZl9S8,1951
+csstweaks_client-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+csstweaks_client-0.1.0.dist-info/top_level.txt,sha256=BWBzUkep7UJcRVvU7da7WLcQoiyEp-QUfLXu94QkO6Y,17
+csstweaks_client-0.1.0.dist-info/RECORD,,

csstweaks_client-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

csstweaks_client-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vasudeva Server
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

csstweaks_client-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+csstweaks_client