touchable-templates 2026.2.1a0__py3-none-any.whl

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.1a0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: touchable-templates
+Version: 2026.2.1a0
+Summary: A dev tool that magically opens templates and partials in your IDE
+Author: Brady Whitby
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.9.2
+Description-Content-Type: text/markdown
+
+
+# touchable-templates
+
+touchable-templates is a small developer helper that wraps rendered templates in a lightweight
+HTML marker and ships a tiny client-side script so you can, for example, click
+on a rendered component in the browser to automatically open the source template in your IDE.
+
+This package is purposely minimal and designed to be installed into Django projects.
+Note: Future versions may support Jinja2, Flask, and other frameworks. This package is not intended to be used in production.
+
+## Key features
+
+- Server-side wrapper for Django template responses (middleware)
+- Small client-side script included as package static files
+
+## Installation
+
+### pip install
+
+```bash
+pip install touchable-templates
+```
+
+### uv install
+
+```bash
+uv add touchable-templates
+```
+
+## Django integration (quick start)
+
+1. Add the app to your `INSTALLED_APPS` in `settings.py`:
+
+```py
+INSTALLED_APPS = [
+    # ...
+  "touchable_templates",
+]
+```
+
+2. Add the middleware so HTML responses are post-processed to convert wrapper containers
+  into elements with the `touchable-templates` class (the client script uses that):
+
+```py
+MIDDLEWARE = [
+    # ...
+  "touchable_templates.django.middleware.TouchableTemplatesMiddleware",
+    # ...
+]
+```
+
+3. Configure enablement and IDE mapping. You can set these via environment variables or
+   in `settings.py`. Example (development):
+
+```py
+# TOUCHABLE_TEMPLATES settings (example)
+TOUCHABLE_TEMPLATES_ENABLE = True
+TOUCHABLE_TEMPLATES_IDE = "vscode"
+# Optional settings: Use if your project is dockerized or paths need adjustment
+TOUCHABLE_TEMPLATES_ROOT = "/full/path/to/your/project/root/on/local/machine"
+TOUCHABLE_TEMPLATES_REMOVE_PREFIX = "project/root/in/docker/container"
+```
+
+## Supported IDEs
+
+- `atom`
+- `codelite`
+- `cursor`
+- `emacs`
+- `espresso`
+- `idea`
+- `macvim`
+- `netbeans`
+- `nova`
+- `pycharm`
+- `sublime`
+- `textmate`
+- `vscode`
+- `vscode-insiders`
+- `vscode-insiders-remote`
+- `vscode-remote`
+- `vscodium`
+- `xdebug`
+
+4. Include the client JavaScript in your base template (requires `django.contrib.staticfiles`):
+Add Script tag at the end of the body, or in the head.
+
+```django
+{% load static %}
+<script src="{% static 'js/touchable_templates.js' %}"></script>
+```
+
+## Use
+
+Press the `alt` or `opt` key to toggle the functionality on and off.
+Moving your mouse around the page you will see a floating element indicating the template path/name
+Click on any element on the page to open the corresponding template in your configured IDE.
+
+## Notes
+
+- The middleware only processes responses with `Content-Type: text/html` to ensure we are not processing json requests.
+- Make sure `TOUCHABLE_TEMPLATES_ENABLE` is `True` in development and `False` in production.
+- 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).
+
+## Troubleshooting
+
+- No overlay appears: verify `TOUCHABLE_TEMPLATES_ENABLE` is True and the JS is loaded correctly (check browser devtools network tab).
+- Alt-click does nothing: ensure the HTML elements have `touchable-templates` class (middleware unwraps container into children).
+
+## License
+
+MIT License (MIT)

touchable_templates-2026.2.1a0.dist-info/RECORD

@@ -0,0 +1,5 @@
+touchable_templates/static/js/touchable_templates.js,sha256=9vxxTAWqbN0V5l7UJqjCc5lkNZ00AGn3nYo35Vkr79c,2436
+touchable_templates-2026.2.1a0.dist-info/METADATA,sha256=KEf6CYd-0PDo-aTty_sf44kmVEexeJI87nXHtT-AXHw,3557
+touchable_templates-2026.2.1a0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+touchable_templates-2026.2.1a0.dist-info/licenses/LICENSE,sha256=5XdcGaWnUE-XZdjP6bSx-Ad0XTkc6heUI3KckeaRZng,1068
+touchable_templates-2026.2.1a0.dist-info/RECORD,,

touchable_templates-2026.2.1a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

touchable_templates-2026.2.1a0.dist-info/licenses/LICENSE

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