dorm-plg 0.1.0__tar.gz

dorm_plg-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DORM Contributors
+
+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.

dorm_plg-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include dorm/templates *.html
+recursive-include dorm/static *.css *.js
+include README.md
+include LICENSE

dorm_plg-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: dorm-plg
+Version: 0.1.0
+Summary: Django ORM playground — dev-only web UI for ORM queries
+Author-email: almamydev <almamydev10@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/almamydev/dorm
+Project-URL: Repository, https://github.com/almamydev/dorm
+Project-URL: Bug Tracker, https://github.com/almamydev/dorm/issues
+Keywords: django,orm,playground,developer-tools,debugging
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Requires-Dist: django-htmx>=1.17
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# DORM
+
+A Django ORM playground — a dev-only web UI to run ORM queries against your connected database.
+
+## Install
+
+```bash
+pip install dorm-plg
+```
+
+## Setup
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "django_htmx", "dorm"]
+MIDDLEWARE = [..., "django_htmx.middleware.HtmxMiddleware"]
+```
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    ...
+    path("__dorm__/", include("dorm.urls", namespace="dorm")),
+]
+```
+
+Open `/__dorm__/` in your browser and start writing ORM queries.
+
+> **Warning**: DORM executes arbitrary Python code in your Django process. It is gated behind `DEBUG=True` and must never be used in production.
+
+## Usage
+
+In the playground editor, write any Django ORM expression. All models from your `INSTALLED_APPS` are available without importing them:
+
+```python
+# Get all users
+User.objects.all()
+
+# Filter with related fields
+Book.objects.filter(author__name="Tolkien").select_related("author")
+
+# Aggregations
+from django.db.models import Count
+Author.objects.annotate(book_count=Count("books")).order_by("-book_count")
+```
+
+Press **Ctrl+Enter** or click **Run** to execute. Results are rendered as a table.
+
+## Development
+
+```bash
+git clone https://github.com/yourname/dorm
+cd dorm
+python3.10 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+cd sandbox && python manage.py migrate && python manage.py runserver
+# Open: http://127.0.0.1:8000/__dorm__/
+```

dorm_plg-0.1.0/README.md

@@ -0,0 +1,61 @@
+# DORM
+
+A Django ORM playground — a dev-only web UI to run ORM queries against your connected database.
+
+## Install
+
+```bash
+pip install dorm-plg
+```
+
+## Setup
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "django_htmx", "dorm"]
+MIDDLEWARE = [..., "django_htmx.middleware.HtmxMiddleware"]
+```
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    ...
+    path("__dorm__/", include("dorm.urls", namespace="dorm")),
+]
+```
+
+Open `/__dorm__/` in your browser and start writing ORM queries.
+
+> **Warning**: DORM executes arbitrary Python code in your Django process. It is gated behind `DEBUG=True` and must never be used in production.
+
+## Usage
+
+In the playground editor, write any Django ORM expression. All models from your `INSTALLED_APPS` are available without importing them:
+
+```python
+# Get all users
+User.objects.all()
+
+# Filter with related fields
+Book.objects.filter(author__name="Tolkien").select_related("author")
+
+# Aggregations
+from django.db.models import Count
+Author.objects.annotate(book_count=Count("books")).order_by("-book_count")
+```
+
+Press **Ctrl+Enter** or click **Run** to execute. Results are rendered as a table.
+
+## Development
+
+```bash
+git clone https://github.com/yourname/dorm
+cd dorm
+python3.10 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+cd sandbox && python manage.py migrate && python manage.py runserver
+# Open: http://127.0.0.1:8000/__dorm__/
+```

dorm_plg-0.1.0/dorm/__init__.py

@@ -0,0 +1,7 @@
+__version__ = "0.1.0"
+
+
+def get_url_prefix() -> str:
+    """Return the URL prefix for DORM, read from settings.DORM_URL (default: '__dorm__')."""
+    from django.conf import settings
+    return getattr(settings, "DORM_URL_NAME", "__dorm__")

dorm_plg-0.1.0/dorm/apps.py

@@ -0,0 +1,16 @@
+from django.apps import AppConfig
+
+
+class DormConfig(AppConfig):
+    name = "dorm"
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self):
+        import logging
+        from django.conf import settings
+
+        if not settings.DEBUG:
+            logging.getLogger("dorm").warning(
+                "DORM is installed but DEBUG=False — all requests will return 404. "
+                "Consider removing 'dorm' from INSTALLED_APPS in production."
+            )

dorm_plg-0.1.0/dorm/exceptions.py

@@ -0,0 +1,6 @@
+class DormNotDebugError(Exception):
+    pass
+
+
+class DormExecutionError(Exception):
+    pass

dorm_plg-0.1.0/dorm/executor.py

@@ -0,0 +1,63 @@
+import ast
+import traceback as tb
+
+
+def _build_namespace() -> dict:
+    from django.apps import apps
+    from django.db.models import Avg, Count, F, Max, Min, OuterRef, Q, Subquery, Sum, Value
+
+    namespace: dict = {
+        "Q": Q, "F": F,
+        "Count": Count, "Sum": Sum, "Avg": Avg, "Max": Max, "Min": Min,
+        "Value": Value, "OuterRef": OuterRef, "Subquery": Subquery,
+    }
+    for model in apps.get_models():
+        namespace[model.__name__] = model
+    return namespace
+
+
+def execute(code: str, extra_locals: dict | None = None) -> dict:
+    """
+    Execute a multi-line ORM code string.
+
+    The last expression in the code block is captured as the result,
+    mimicking REPL behaviour. Returns:
+      {"success": True,  "result": <any>}
+      {"success": False, "error_type": str, "error": str, "traceback": str}
+    """
+    namespace = _build_namespace()
+    if extra_locals:
+        namespace.update(extra_locals)
+
+    try:
+        tree = ast.parse(code)
+    except SyntaxError as e:
+        return {
+            "success": False,
+            "error_type": "SyntaxError",
+            "error": str(e),
+            "traceback": "",
+        }
+
+    try:
+        result = None
+        if tree.body and isinstance(tree.body[-1], ast.Expr):
+            # Split: exec all statements, eval the last expression
+            exec_tree = ast.Module(body=tree.body[:-1], type_ignores=[])
+            eval_tree = ast.Expression(body=tree.body[-1].value)
+            ast.fix_missing_locations(exec_tree)
+            ast.fix_missing_locations(eval_tree)
+            exec(compile(exec_tree, "<dorm>", "exec"), namespace)
+            result = eval(compile(eval_tree, "<dorm>", "eval"), namespace)
+        else:
+            exec(compile(tree, "<dorm>", "exec"), namespace)
+
+        return {"success": True, "result": result}
+
+    except Exception as e:
+        return {
+            "success": False,
+            "error_type": type(e).__name__,
+            "error": str(e),
+            "traceback": tb.format_exc(),
+        }

dorm_plg-0.1.0/dorm/static/dorm/css/dorm.css

@@ -0,0 +1,383 @@
+/* DORM — Django ORM Playground */
+
+:root {
+    --bg:              #e0e0e0;
+    --surface:         #ffffff;
+    --border:          #cccccc;
+    --header-bg:       #111111;
+    --header-text:     #ffffff;
+    --pane-bar-bg:     #f4f4f4;
+    --pane-bar-border: #e0e0e0;
+    --text:            #000000;
+    --text-muted:      #666666;
+    --divider:         #c0c0c0;
+    --divider-hover:   #555555;
+    --btn-bg:          #000000;
+    --btn-text:        #ffffff;
+    --btn-hover:       #333333;
+    --th-bg:           #1a1a1a;
+    --th-text:         #ffffff;
+    --td-border:       #eeeeee;
+    --row-hover:       #fafafa;
+    --value-bg:        #f8f8f8;
+    --error-bg:        #fff8f8;
+    --error-border:    #e0b0b0;
+    --error-text:      #cc0000;
+    --kbd-bg:          rgba(255,255,255,0.18);
+}
+
+*, *::before, *::after {
+    box-sizing: border-box;
+    margin: 0;
+    padding: 0;
+}
+
+html, body {
+    height: 100%;
+    overflow: hidden;
+    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+    background: var(--bg);
+    color: var(--text);
+}
+
+/* ── Root shell ──────────────────────────────────────────── */
+
+.dorm-root {
+    display: flex;
+    flex-direction: column;
+    height: 100vh;
+    overflow: hidden;
+}
+
+/* ── Header ──────────────────────────────────────────────── */
+
+.dorm-header {
+    flex: 0 0 auto;
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    padding: 0 1rem;
+    height: 44px;
+    background: var(--header-bg);
+    color: var(--header-text);
+}
+
+.dorm-logo {
+    font-size: 0.95rem;
+    font-weight: 700;
+    letter-spacing: 0.18em;
+    color: var(--header-text);
+}
+
+/* ── Layout toggle buttons ───────────────────────────────── */
+
+.dorm-layout-toggle {
+    display: flex;
+    gap: 2px;
+    background: rgba(255,255,255,0.08);
+    border-radius: 5px;
+    padding: 3px;
+}
+
+.dorm-layout-opt {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    width: 30px;
+    height: 26px;
+    background: transparent;
+    border: none;
+    border-radius: 3px;
+    color: #888;
+    cursor: pointer;
+    transition: background 0.1s, color 0.1s;
+}
+
+.dorm-layout-opt:hover {
+    color: #ccc;
+}
+
+.dorm-layout-opt.active {
+    background: #ffffff;
+    color: #000000;
+}
+
+/* ── Split layout container ──────────────────────────────── */
+
+.dorm-layout {
+    flex: 1;
+    display: flex;
+    min-height: 0;
+    gap: 0;
+}
+
+.dorm-layout[data-dir="row"]  { flex-direction: row; }
+.dorm-layout[data-dir="col"]  { flex-direction: column; }
+
+/* ── Panes ───────────────────────────────────────────────── */
+
+.dorm-pane {
+    display: flex;
+    flex-direction: column;
+    overflow: hidden;
+    min-width: 0;
+    min-height: 0;
+    background: var(--surface);
+}
+
+#dorm-pane-a { flex: 0 0 50%; }
+#dorm-pane-b { flex: 1 1 0; }
+
+/* ── Pane top bar ────────────────────────────────────────── */
+
+.dorm-pane-bar {
+    flex: 0 0 auto;
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    padding: 0 0.875rem;
+    height: 36px;
+    background: var(--pane-bar-bg);
+    border-bottom: 1px solid var(--pane-bar-border);
+}
+
+.dorm-pane-label {
+    font-size: 0.72rem;
+    font-weight: 600;
+    letter-spacing: 0.1em;
+    text-transform: uppercase;
+    color: var(--text-muted);
+}
+
+/* ── Editor (input pane) ─────────────────────────────────── */
+
+#dorm-form {
+    flex: 1;
+    display: flex;
+    flex-direction: column;
+    min-height: 0;
+}
+
+.dorm-editor {
+    flex: 1;
+    width: 100%;
+    padding: 0.875rem 1rem;
+    background: var(--surface);
+    color: var(--text);
+    font-family: "JetBrains Mono", "Fira Code", Consolas, "Courier New", monospace;
+    font-size: 0.875rem;
+    line-height: 1.65;
+    border: none;
+    outline: none;
+    resize: none;
+}
+
+/* ── Verbose names checkbox ──────────────────────────────── */
+
+.dorm-verbose-label {
+    display: flex;
+    align-items: center;
+    gap: 0.35rem;
+    font-size: 0.72rem;
+    font-weight: 500;
+    color: var(--text-muted);
+    cursor: pointer;
+    user-select: none;
+}
+
+.dorm-verbose-label input[type="checkbox"] {
+    accent-color: var(--btn-bg);
+    cursor: pointer;
+    width: 13px;
+    height: 13px;
+}
+
+/* ── Run button ──────────────────────────────────────────── */
+
+.dorm-run-btn {
+    display: inline-flex;
+    align-items: center;
+    gap: 0.45rem;
+    padding: 0.3rem 0.9rem;
+    background: var(--btn-bg);
+    color: var(--btn-text);
+    border: none;
+    border-radius: 4px;
+    font-size: 0.8rem;
+    font-weight: 600;
+    cursor: pointer;
+    transition: background 0.12s;
+}
+
+.dorm-run-btn:hover  { background: var(--btn-hover); }
+.dorm-run-btn:active { background: #555; }
+
+kbd {
+    font-size: 0.7rem;
+    padding: 0.1em 0.35em;
+    background: var(--kbd-bg);
+    border-radius: 3px;
+    font-family: inherit;
+}
+
+/* ── Divider ─────────────────────────────────────────────── */
+
+.dorm-divider {
+    flex: 0 0 5px;
+    background: var(--divider);
+    transition: background 0.12s;
+    position: relative;
+}
+
+.dorm-layout[data-dir="row"] .dorm-divider  { cursor: col-resize; }
+.dorm-layout[data-dir="col"] .dorm-divider  { cursor: row-resize; }
+
+.dorm-divider:hover { background: var(--divider-hover); }
+
+/* Expand hit area by 4px on each side */
+.dorm-layout[data-dir="row"] .dorm-divider::after {
+    content: "";
+    position: absolute;
+    inset: 0 -4px;
+}
+.dorm-layout[data-dir="col"] .dorm-divider::after {
+    content: "";
+    position: absolute;
+    inset: -4px 0;
+}
+
+/* ── Result body ─────────────────────────────────────────── */
+
+.dorm-result-body {
+    flex: 1;
+    overflow: auto;
+    padding: 0.875rem 1rem;
+}
+
+/* ── Result bar (meta + export buttons) ─────────────────── */
+
+.dorm-result-bar {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    margin-bottom: 0.5rem;
+}
+
+.dorm-result-meta {
+    font-size: 0.75rem;
+    color: var(--text-muted);
+    margin-bottom: 0.5rem;
+}
+
+.dorm-export-btns {
+    display: flex;
+    gap: 4px;
+}
+
+.dorm-export-btn {
+    padding: 0.2rem 0.6rem;
+    background: transparent;
+    color: var(--text-muted);
+    border: 1px solid var(--border);
+    border-radius: 3px;
+    font-size: 0.72rem;
+    font-weight: 600;
+    cursor: pointer;
+    transition: background 0.1s, color 0.1s, border-color 0.1s;
+}
+
+.dorm-export-btn:hover {
+    background: var(--btn-bg);
+    color: var(--btn-text);
+    border-color: var(--btn-bg);
+}
+
+.dorm-table-wrapper {
+    overflow-x: auto;
+    border: 1px solid var(--border);
+    border-radius: 4px;
+}
+
+.dorm-table {
+    width: 100%;
+    border-collapse: collapse;
+    font-size: 0.8rem;
+}
+
+.dorm-table th {
+    padding: 0.5rem 0.875rem;
+    background: var(--th-bg);
+    color: var(--th-text);
+    text-align: left;
+    font-weight: 600;
+    white-space: nowrap;
+    border-bottom: none;
+}
+
+.dorm-table td {
+    padding: 0.4rem 0.875rem;
+    border-bottom: 1px solid var(--td-border);
+    color: var(--text);
+    font-family: "JetBrains Mono", Consolas, monospace;
+    white-space: nowrap;
+}
+
+.dorm-table tr:last-child td { border-bottom: none; }
+.dorm-table tr:hover td      { background: var(--row-hover); }
+
+/* ── Value output ────────────────────────────────────────── */
+
+.dorm-value {
+    padding: 0.875rem 1rem;
+    background: var(--value-bg);
+    border: 1px solid var(--border);
+    border-radius: 4px;
+    color: var(--text);
+    font-family: "JetBrains Mono", Consolas, monospace;
+    font-size: 0.8rem;
+    white-space: pre-wrap;
+    word-break: break-word;
+}
+
+/* ── Error output ────────────────────────────────────────── */
+
+.dorm-error {
+    padding: 0.875rem 1rem;
+    background: var(--error-bg);
+    border: 1px solid var(--error-border);
+    border-radius: 4px;
+}
+
+.dorm-error-title {
+    font-family: "JetBrains Mono", Consolas, monospace;
+    font-size: 0.8rem;
+    font-weight: 700;
+    color: var(--error-text);
+    margin-bottom: 0.5rem;
+}
+
+.dorm-error-traceback {
+    font-family: "JetBrains Mono", Consolas, monospace;
+    font-size: 0.75rem;
+    color: var(--error-text);
+    white-space: pre-wrap;
+    word-break: break-word;
+    opacity: 0.75;
+}
+
+/* ── Drag state ──────────────────────────────────────────── */
+
+body.is-resizing-row {
+    cursor: col-resize !important;
+    user-select: none;
+}
+body.is-resizing-col {
+    cursor: row-resize !important;
+    user-select: none;
+}
+
+/* Prevent pane content from stealing the cursor during drag */
+body.is-resizing-row .dorm-pane,
+body.is-resizing-col .dorm-pane {
+    pointer-events: none;
+}