touchable-templates 2026.2.3a0__py3-none-any.whl → 2026.2.6a0__py3-none-any.whl

touchable_templates/__init__.py

@@ -0,0 +1 @@
+"""Touchable Templates package initializer."""

touchable_templates/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class TouchableTemplatesConfig(AppConfig):
+    name = "touchable_templates"

touchable_templates/django/loader.py

@@ -0,0 +1,124 @@
+from django.template.loaders.filesystem import Loader as FileSystemLoader
+from django.template.loaders.app_directories import Loader as AppDirectoriesLoader
+from django.conf import settings
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+
+IDE_TO_URI_MAPPER = {
+    "atom": "atom://core/open/file?filename=",
+    "codelite": "codelite://open?file=",
+    "cursor": "cursor://file/",
+    "emacs": "emacs://open?url=",
+    "espresso": "x-espresso://open?filepath=",
+    "idea": "idea://open?file=",
+    "macvim": "mvim://open/?url=",
+    "netbeans": "netbeans://open/?f=",
+    "nova": "nova://open?path=",
+    "pycharm": "pycharm://open?file=",
+    "sublime": "subl://open?url=",
+    "textmate": "txmt://open?url=",
+    "vscode": "vscode://file/",
+    "vscode-insiders": "vscode-insiders://file/",
+    "vscode-insiders-remote": "vscode-insiders://vscode-remote/",
+    "vscode-remote": "vscode://vscode-remote/",
+    "vscodium": "vscodium://file/",
+    "xdebug": "xdebug://",
+}
+
+
+def _is_third_party(filename: str) -> bool:
+    return "site-packages" in filename or "dist-packages" in filename
+
+
+def _get_setting_or_env(name):
+    # Prefer Django setting, fall back to environment variable
+    return getattr(settings, name, None) or os.environ.get(name)
+
+
+def _inject_ide_link(source_content, template_name, filename):
+    touchable_templates_ide = _get_setting_or_env("TOUCHABLE_TEMPLATES_IDE")
+    custom_uri = IDE_TO_URI_MAPPER.get(touchable_templates_ide)
+    touchable_templates_root = _get_setting_or_env("TOUCHABLE_TEMPLATES_ROOT") or ""
+    touchable_templates_remove_prefix = _get_setting_or_env("TOUCHABLE_TEMPLATES_REMOVE_PREFIX") or ""
+
+    try:
+        # compute a relative path portion if a remove-prefix was provided
+        rel_path = filename
+        if touchable_templates_remove_prefix and filename.startswith(touchable_templates_remove_prefix):
+            rel_path = filename[len(touchable_templates_remove_prefix):]
+
+        absolute_template_path = (custom_uri or "") + touchable_templates_root + rel_path
+    except Exception:
+        absolute_template_path = filename
+
+    # If template extends another template, we avoid wrapping the child; Django
+    # templates are compiled in processor order so this is a best-effort approach.
+
+    bordered = (
+        f'<div class="touchable-templates-container" '
+        f'data-template-name="{template_name}" '
+        f'data-template-path="{absolute_template_path}" '
+        f'style="display: block;">{source_content}</div>'
+    )
+
+    return bordered
+
+
+class TouchableTemplatesLoader(FileSystemLoader):
+    """A drop-in replacement for Django's filesystem.Loader that wraps
+    template source in a touchable-templates container when enabled.
+
+    To use: in `TEMPLATES[...]['OPTIONS']['loaders']` reference
+    `touchable_templates.django.loader.TouchableTemplatesLoader` instead of
+    `django.template.loaders.filesystem.Loader`.
+    """
+
+    def get_contents(self, origin):
+        source = super().get_contents(origin)
+
+        enabled = _get_setting_or_env("TOUCHABLE_TEMPLATES_ENABLE")
+        if not enabled:
+            return source
+
+        try:
+            template_name = getattr(origin, "template_name", None) or getattr(origin, "name", "")
+            filename = getattr(origin, "name", "")
+
+            if _is_third_party(filename):
+                return source
+
+            return _inject_ide_link(source, template_name, filename)
+        except Exception:
+            logger.exception("touchable_templates: failed to inject IDE link into Django template")
+            return source
+
+
+class TouchableTemplatesAppDirectoriesLoader(AppDirectoriesLoader):
+    """A drop-in replacement for Django's app_directories.Loader that wraps
+    template source in a touchable-templates container when enabled.
+
+    To use: in `TEMPLATES[...]['OPTIONS']['loaders']` reference
+    `touchable_templates.django.loader.TouchableTemplatesAppDirectoriesLoader` instead of
+    `django.template.loaders.app_directories.Loader`.
+    """
+
+    def get_contents(self, origin):
+        source = super().get_contents(origin)
+
+        enabled = _get_setting_or_env("TOUCHABLE_TEMPLATES_ENABLE")
+        if not enabled:
+            return source
+
+        try:
+            template_name = getattr(origin, "template_name", None) or getattr(origin, "name", "")
+            filename = getattr(origin, "name", "")
+
+            if _is_third_party(filename):
+                return source
+
+            return _inject_ide_link(source, template_name, filename)
+        except Exception:
+            logger.exception("touchable_templates: failed to inject IDE link into Django app template")
+            return source

touchable_templates/django/middleware.py

@@ -0,0 +1,52 @@
+from django.utils.deprecation import MiddlewareMixin
+from django.conf import settings
+from bs4 import BeautifulSoup
+
+
+class TouchableTemplatesMiddleware(MiddlewareMixin):
+    """
+    Middleware to post-process Django template responses and mark children with
+    the `touchable-templates` class so the client script can provide IDE links.
+    """
+
+    def process_response(self, request, response):
+        if not getattr(settings, "TOUCHABLE_TEMPLATES_ENABLE", False):
+            return response
+
+        content_type = response.get('Content-Type', '').split(';')[0]
+        if content_type != 'text/html':
+            return response
+        
+        # Decode the response content
+        content = response.content.decode(response.charset)
+        soup = BeautifulSoup(content, 'html.parser')
+
+        # Find all elements with class 'touchable-templates-container'
+        containers = soup.find_all(class_='touchable-templates-container')
+        for container in containers:
+            # Get data attributes from the container
+            data_template_name = container.get('data-template-name')
+            data_template_path = container.get('data-template-path')
+
+            # Iterate over direct children of the container
+            for child in container.find_all(recursive=False):
+                # Add 'touchable-templates' class to the child
+                existing_classes = child.get('class', [])
+                if 'touchable-templates' not in existing_classes:
+                    child['class'] = existing_classes + ['touchable-templates']
+
+                # Copy data attributes to the child
+                if data_template_name:
+                    child['data-template-name'] = data_template_name
+                if data_template_path:
+                    child['data-template-path'] = data_template_path
+
+            # Remove the container but keep its children
+            container.unwrap()
+
+        # Update the response content
+        updated_content = str(soup).encode(response.charset)
+        response.content = updated_content
+        response['Content-Length'] = len(response.content)
+
+        return response

touchable_templates/static/js/touchable_templates.js

@@ -0,0 +1,66 @@
+let altToggled = false;
+
+// Append the element to the DOM, for example, to the body
+var elemDiv = document.createElement('div');
+elemDiv.id = 'floating-template-name';
+elemDiv.style.cssText = "display: none; position: absolute; background: white; border: 1px solid black; padding: 5px; z-index: 9999;"
+document.body.appendChild(elemDiv);
+const floatingElement = document.getElementById("floating-template-name");    
+
+document.addEventListener("DOMContentLoaded", function(event) {
+
+    document.addEventListener('keydown', function(event) {
+        if (event.key === 'Alt') {
+            altToggled = !altToggled;
+            if (!altToggled) {
+                floatingElement.style.display = 'none';
+            }
+        }
+    });
+
+    document.addEventListener('click', function(event) {
+        if (altToggled) {
+            let closestElement = event.target.closest('.touchable-templates');
+            if (closestElement) {
+                let templatePath = closestElement.getAttribute('data-template-path');
+                if (templatePath) {
+                    window.open(templatePath, '_blank');
+                    event.stopPropagation();
+                }
+            }
+        }
+    }, true);
+
+    document.addEventListener('mousemove', (e) => {
+        if (!altToggled) return;
+        const el = e.target.closest('.touchable-templates');
+        if (!el) return floatingElement.style.display = 'none';
+
+        const name = el.getAttribute('data-template-name');
+        if (!name) return;
+
+        floatingElement.textContent = name;
+        floatingElement.style.display = 'block';
+        const { pageX: x, pageY: y } = e;
+        const { offsetWidth: w, offsetHeight: h } = floatingElement;
+        const { innerWidth: vw, innerHeight: vh } = window;
+        floatingElement.style.left = `${x + w + 20 > vw ? x - w - 5 : x + 10}px`;
+        floatingElement.style.top = `${y + h + 20 > vh ? y - h - 5 : y + 10}px`;
+    });
+
+    document.addEventListener('mouseleave', () => {
+        floatingElement.style.display = 'none';
+    });
+
+    document.addEventListener('mouseenter', (e) => {
+        if (altToggled) {
+            const el = e.target.closest('.touchable-templates');
+            if (el) {
+                const name = el.getAttribute('data-template-name');
+                floatingElement.textContent = name;
+                floatingElement.style.display = 'block';
+            }
+        }
+    });
+
+});

{touchable_templates-2026.2.3a0.dist-info → touchable_templates-2026.2.6a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: touchable-templates
-Version: 2026.2.3a0
+Version: 2026.2.6a0
 Summary: A dev tool that magically opens templates and partials in your IDE
 Author: Brady Whitby
 License-Expression: MIT
@@ -114,6 +114,8 @@ Click on any element on the page to open the corresponding template in your conf
 - Use `TOUCHABLE_TEMPLATES_REMOVE_PREFIX` to strip any leading path segments that are
   not part of the local filesystem path (e.g. if your project runs in a Docker container
   with a different root path).
+- Touchable-templates only processes templates that are part of your project.
+  It skips templates that are part of third-party packages (e.g. in `site-packages` or `dist-packages`).
 
 ## Troubleshooting
 

touchable_templates-2026.2.6a0.dist-info/RECORD

@@ -0,0 +1,9 @@
+touchable_templates/__init__.py,sha256=wuVP6KxqX0TnmQegZGdHALFdKInO22IOx2lIbhObvQw,47
+touchable_templates/apps.py,sha256=3qlRtprhZRI5wPnYLEz6QAWHwACeZvKO7RV-C8Gv1Uc,112
+touchable_templates/django/loader.py,sha256=ePcYi4TnJjcx2c_TGJ6lAzKJ2X6k0BREK1hzjg9y5lk,4679
+touchable_templates/django/middleware.py,sha256=LYKs-WRO9q_wpQVzFlDxxL5Z2E6Ny49EQwWf2L-Si0o,2147
+touchable_templates/static/js/touchable_templates.js,sha256=9vxxTAWqbN0V5l7UJqjCc5lkNZ00AGn3nYo35Vkr79c,2436
+touchable_templates-2026.2.6a0.dist-info/METADATA,sha256=2LKQzLRmD5pAsObqdmiOphfRLDBfXDg_Ijz2bvz7vkg,3740
+touchable_templates-2026.2.6a0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+touchable_templates-2026.2.6a0.dist-info/licenses/LICENSE,sha256=5XdcGaWnUE-XZdjP6bSx-Ad0XTkc6heUI3KckeaRZng,1068
+touchable_templates-2026.2.6a0.dist-info/RECORD,,

touchable_templates-2026.2.3a0.dist-info/RECORD

@@ -1,4 +0,0 @@
-touchable_templates-2026.2.3a0.dist-info/METADATA,sha256=v19J3Ixvm2hFhxbhUeWrWNns9ikAQH6U6hzz2XZze0I,3557
-touchable_templates-2026.2.3a0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-touchable_templates-2026.2.3a0.dist-info/licenses/LICENSE,sha256=5XdcGaWnUE-XZdjP6bSx-Ad0XTkc6heUI3KckeaRZng,1068
-touchable_templates-2026.2.3a0.dist-info/RECORD,,