sqliter-py 0.12.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

sqliter/tui/styles/app.tcss

@@ -0,0 +1,130 @@
+/* Main application styles for SQLiter TUI Demo */
+
+Screen {
+    background: $surface;
+}
+
+#main-container {
+    layout: grid;
+    grid-size: 2;
+    grid-columns: auto 1fr;
+    height: 100%;
+    padding: 0 1;
+}
+
+/* Left panel - Demo list */
+#demo-list {
+    border: solid $primary;
+    border-title-color: $text;
+    padding: 1;
+}
+
+#demo-list Tree {
+    padding: 0;
+}
+
+#demo-list Tree > .tree--cursor {
+    background: $primary;
+    color: $text;
+}
+
+#demo-list Tree > .tree--highlight {
+    background: $primary 30%;
+}
+
+/* Right panel container */
+#right-panel {
+    padding-left: 1;
+}
+
+/* Code display */
+#code-display {
+    height: 55%;
+    border: solid $primary;
+    border-title-color: $text;
+    padding: 1;
+}
+
+#code-display Static {
+    padding: 0;
+}
+
+/* Output display */
+#output-display {
+    height: 35%;
+    border: solid $secondary;
+    border-title-color: $text;
+    padding: 1;
+}
+
+#output-display.success {
+    border: solid $success;
+}
+
+#output-display.error {
+    border: solid $error;
+}
+
+#output-display Static {
+    padding: 0;
+}
+
+/* Button bar */
+#button-bar {
+    height: auto;
+    align: center middle;
+    padding: 1 0;
+}
+
+#button-bar Button {
+    margin: 0 1;
+}
+
+#run-btn {
+    background: $success;
+}
+
+#clear-btn {
+    background: $primary-darken-2;
+}
+
+/* Help screen */
+HelpScreen {
+    align: center middle;
+}
+
+#help-scroll {
+    width: 70;
+    height: auto;
+    max-height: 80%;
+    padding: 2;
+    border: solid $primary;
+    background: $surface;
+}
+
+#help-content {
+    padding: 0;
+}
+
+/* Footer styling */
+Footer {
+    background: $primary-darken-3;
+}
+
+/* Header styling */
+Header {
+    background: $primary;
+}
+
+/* Scrollbars */
+ScrollableContainer > .scrollbar {
+    background: $surface;
+}
+
+ScrollableContainer > .scrollbar--bar {
+    background: $primary 50%;
+}
+
+ScrollableContainer > .scrollbar--bar:hover {
+    background: $primary;
+}

sqliter/tui/widgets/__init__.py

@@ -0,0 +1,7 @@
+"""TUI widgets for SQLiter demo app."""
+
+from sqliter.tui.widgets.code_display import CodeDisplay
+from sqliter.tui.widgets.demo_list import DemoList, DemoSelected
+from sqliter.tui.widgets.output_display import OutputDisplay
+
+__all__ = ["CodeDisplay", "DemoList", "DemoSelected", "OutputDisplay"]

sqliter/tui/widgets/code_display.py

@@ -0,0 +1,81 @@
+"""Syntax-highlighted code display widget."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from rich.syntax import Syntax
+from textual.containers import ScrollableContainer
+from textual.css.query import NoMatches
+from textual.widgets import Static
+
+if TYPE_CHECKING:  # pragma: no cover
+    from textual.app import ComposeResult
+
+
+class CodeDisplay(ScrollableContainer):
+    """Display syntax-highlighted Python code."""
+
+    def __init__(
+        self,
+        code: str = "",
+        *,
+        widget_id: str | None = None,
+        classes: str | None = None,
+    ) -> None:
+        """Initialize the code display.
+
+        Args:
+            code: Initial code to display.
+            widget_id: Widget ID.
+            classes: CSS classes for the widget.
+        """
+        super().__init__(id=widget_id, classes=classes)
+        self._code = code
+
+    def compose(self) -> ComposeResult:
+        """Compose the code display."""
+        yield Static(id="code-content")
+
+    def on_mount(self) -> None:
+        """Initialize the display on mount."""
+        self._update_display()
+
+    @property
+    def code(self) -> str:
+        """Get the current code."""
+        return self._code
+
+    @code.setter
+    def code(self, value: str) -> None:
+        """Set new code and update display."""
+        self._code = value
+        self._update_display()
+
+    def _update_display(self) -> None:
+        """Update the code display with syntax highlighting."""
+        try:
+            content = self.query_one("#code-content", Static)
+        except NoMatches:
+            return  # Not mounted yet
+
+        if not self._code:
+            content.update("Select a demo to view code")
+            return
+
+        # Use Rich's Syntax for highlighting
+        syntax = Syntax(
+            self._code.strip(),
+            "python",
+            theme="monokai",
+            line_numbers=True,
+            word_wrap=True,
+        )
+        content.update(syntax)
+
+        # Scroll to top when content changes
+        self.scroll_home()
+
+    def set_code(self, code: str) -> None:
+        """Set the code to display (public API)."""
+        self.code = code

sqliter/tui/widgets/demo_list.py

@@ -0,0 +1,65 @@
+"""Demo list widget with expandable categories."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from textual.containers import ScrollableContainer
+from textual.message import Message
+from textual.widgets import Tree
+
+from sqliter.tui.demos import DemoRegistry
+from sqliter.tui.demos.base import Demo, DemoCategory
+
+if TYPE_CHECKING:  # pragma: no cover
+    from textual.app import ComposeResult
+
+
+class DemoSelected(Message):
+    """Message sent when a demo is selected."""
+
+    def __init__(self, demo: Demo) -> None:
+        """Initialize the message.
+
+        Args:
+            demo: The demo that was selected.
+        """
+        self.demo = demo
+        super().__init__()
+
+
+class DemoList(ScrollableContainer):
+    """Scrollable tree of demo categories and items."""
+
+    def compose(self) -> ComposeResult:
+        """Compose the demo tree."""
+        tree: Tree[Demo | DemoCategory] = Tree("SQLiter Demos", id="demo-tree")
+        tree.show_root = False
+
+        # Populate tree with categories and demos
+        for category in DemoRegistry.get_categories():
+            label = (
+                f"{category.icon} {category.title}"
+                if category.icon
+                else category.title
+            )
+            cat_node = tree.root.add(
+                label,
+                data=category,
+                expand=category.expanded,
+            )
+            for demo in category.demos:
+                cat_node.add_leaf(
+                    demo.title,
+                    data=demo,
+                )
+
+        yield tree
+
+    def on_tree_node_selected(
+        self,
+        event: Tree.NodeSelected[Demo | DemoCategory],
+    ) -> None:
+        """Handle tree node selection."""
+        if isinstance(event.node.data, Demo):
+            self.post_message(DemoSelected(event.node.data))

sqliter/tui/widgets/output_display.py

@@ -0,0 +1,92 @@
+"""Output display widget with status indication."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from rich.text import Text
+from textual.containers import ScrollableContainer
+from textual.widgets import Static
+
+if TYPE_CHECKING:  # pragma: no cover
+    from textual.app import ComposeResult
+
+
+class OutputDisplay(ScrollableContainer):
+    """Display demo execution output with status styling."""
+
+    _PLACEHOLDER = "Run a demo to see output here"
+
+    def __init__(
+        self,
+        *,
+        widget_id: str | None = None,
+        classes: str | None = None,
+    ) -> None:
+        """Initialize the output display.
+
+        Args:
+            widget_id: Widget ID.
+            classes: CSS classes for the widget.
+        """
+        super().__init__(id=widget_id, classes=classes)
+
+    def compose(self) -> ComposeResult:
+        """Compose the output display."""
+        yield Static(self._PLACEHOLDER, id="output-content")
+
+    def show_output(self, output: str, *, success: bool = True) -> None:
+        """Display output from demo execution.
+
+        Args:
+            output: The output text to display
+            success: Whether the demo ran successfully
+        """
+        content = self.query_one("#output-content", Static)
+
+        self.remove_class("error", "success")
+        self.add_class("success" if success else "error")
+
+        if success:
+            text = Text()
+            text.append("Success\n\n", style="bold green")
+            text.append(output)
+        else:
+            text = Text()
+            text.append("Error\n\n", style="bold red")
+            text.append(output, style="red")
+
+        content.update(text)
+        self.scroll_home()
+
+    def show_error(
+        self,
+        error: str,
+        traceback_str: str | None = None,
+    ) -> None:
+        """Display an error message.
+
+        Args:
+            error: The error message
+            traceback_str: Optional full traceback
+        """
+        content = self.query_one("#output-content", Static)
+
+        self.remove_class("error", "success")
+        self.add_class("error")
+
+        text = Text()
+        text.append("Error\n\n", style="bold red")
+        text.append(error, style="red")
+        if traceback_str:
+            text.append("\n\nTraceback:\n", style="bold")
+            text.append(traceback_str, style="dim red")
+
+        content.update(text)
+        self.scroll_home()
+
+    def clear(self) -> None:
+        """Clear the output display."""
+        content = self.query_one("#output-content", Static)
+        content.update(self._PLACEHOLDER)
+        self.remove_class("error", "success")

{sqliter_py-0.12.0.dist-info → sqliter_py-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqliter-py
-Version: 0.12.0
+Version: 0.16.0
 Summary: Interact with SQLite databases using Python and Pydantic
 Author: Grant Ramsay
 Author-email: Grant Ramsay <grant@gnramsay.com>
@@ -20,14 +20,19 @@ Classifier: Topic :: Database :: Front-Ends
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: pydantic>=2.12.5
+Requires-Dist: textual>=7.3.0 ; extra == 'demo'
 Requires-Dist: inflect==7.0.0 ; extra == 'extras'
+Requires-Dist: inflect>=7.0.0 ; extra == 'full'
+Requires-Dist: textual>=7.3.0 ; extra == 'full'
 Requires-Python: >=3.9
-Project-URL: Bug Tracker, https://github.com/seapagan/sqliter-py/issues
-Project-URL: Changelog, https://github.com/seapagan/sqliter-py/blob/main/CHANGELOG.md
 Project-URL: Homepage, http://sqliter.grantramsay.dev
 Project-URL: Pull Requests, https://github.com/seapagan/sqliter-py/pulls
+Project-URL: Bug Tracker, https://github.com/seapagan/sqliter-py/issues
+Project-URL: Changelog, https://github.com/seapagan/sqliter-py/blob/main/CHANGELOG.md
 Project-URL: Repository, https://github.com/seapagan/sqliter-py
+Provides-Extra: demo
 Provides-Extra: extras
+Provides-Extra: full
 Description-Content-Type: text/markdown
 
 # SQLiter <!-- omit in toc -->
@@ -87,6 +92,7 @@ Full documentation is available on the [Website](https://sqliter.grantramsay.dev
 - Custom exceptions for better error handling
 - Full type hinting and type checking
 - Detailed documentation and examples
+- Interactive TUI demo for exploring features
 - No external dependencies other than Pydantic
 - Full test coverage
 - Can optionally output the raw SQL queries being executed for debugging
@@ -122,9 +128,9 @@ Currently by default, the only external dependency is Pydantic. However, there
 are some optional dependencies that can be installed to enable additional
 features:
 
-- `inflect`: For pluralizing the auto-generated table names (if not explicitly
-  set in the Model) This just offers a more-advanced pluralization than the
-  default method used. In most cases you will not need this.
+- `demo`: Installs the Textual TUI framework for the interactive demo
+- `extras`: Installs Inflect for better pluralization of table names
+- `full`: Installs all optional dependencies (Textual and Inflect)
 
 See [Installing Optional
 Dependencies](https://sqliter.grantramsay.dev/installation#optional-dependencies)
@@ -173,6 +179,16 @@ See the [Guide](https://sqliter.grantramsay.dev/guide/guide/) section of the
 documentation for more detailed information on how to use SQLiter, and advanced
 features.
 
+You can also run the interactive TUI demo to explore SQLiter features hands-on:
+
+```bash
+# Install the demo
+uv add sqliter-py[demo]
+
+# Run the demo
+sqliter-demo
+```
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
@@ -187,7 +203,7 @@ which you can read in the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
 This project is licensed under the MIT License.
 
 ```pre
-Copyright (c) 2024-2025 Grant Ramsay
+Copyright (c) 2024-2026 Grant Ramsay
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

sqliter_py-0.16.0.dist-info/RECORD

@@ -0,0 +1,47 @@
+sqliter/__init__.py,sha256=ECfn02OPmiMCQvRYbfizKFhVDk00xV-HV1s2cH9037I,244
+sqliter/constants.py,sha256=lZ5PKJRofr9Hh8-R7QFt06DV0LiGb3MGY8D-rTklMCk,1279
+sqliter/exceptions.py,sha256=FCVImm9zpMsAcqApAKPA8KLFLtX2ScGT3sMO1XScRhE,6970
+sqliter/helpers.py,sha256=d6k4oWl43Se_c8rAmX8Zj0_sf2O-bpaaeu33VN2IcsI,3442
+sqliter/model/__init__.py,sha256=IZC6you0Wt2o0OovmgBIszt7JzuIY7kMFBpcLwIhcCI,1304
+sqliter/model/foreign_key.py,sha256=aaUJ-02o2_g9JOaxUoicaGTwNwjFS_Si4eYec0bMrqY,5381
+sqliter/model/model.py,sha256=pFs8xEQANvipT5_vQPyiyxA_WZsiwT1PVdMR9xoT1aI,9643
+sqliter/model/unique.py,sha256=-Jh56jBv5cjWmZpChwm5jDb_hZBvcqP0gy6MeCNyJvk,827
+sqliter/orm/__init__.py,sha256=7cBEjOfPVkwWevAEaHmEwlZgGX4J_kMQukTFgRpSGGQ,565
+sqliter/orm/fields.py,sha256=P5qxVNwNeFgTmO1ctzEUC7GKyCn-MoojYUjyzDU5tkA,14270
+sqliter/orm/foreign_key.py,sha256=vMoI5deMsi34eocIyniAIXuWSf5jyOZ_nh2kCPhrbMc,154
+sqliter/orm/model.py,sha256=FiR6vvFnTuCeUZ_G6t0vrwU23XOeQ6FvA-rRILs0qP4,10195
+sqliter/orm/query.py,sha256=QvOU86c6l_wqKGlCBeGNjkcmTybK0a984eo7pauPngw,5970
+sqliter/orm/registry.py,sha256=NZJZmgumJ4NF2akB1xdPWYNbxxv0s2KG6XU_ts0ezrw,5389
+sqliter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqliter/query/__init__.py,sha256=MRajhjTPJqjbmmrwndVKj8vqMbK5-XufpwoIswQf5z4,239
+sqliter/query/query.py,sha256=8QsXjDsnto2d5O-GNCF1HehudTAPDYHqXKDTQZI3ULA,50759
+sqliter/sqliter.py,sha256=KixFltlcT9fXLqahXnCgupmD-ipEsgF41ckDjoKMorA,41685
+sqliter/tui/__init__.py,sha256=1-WNXJUzPp_y8FZh1XWzSGzCG1gd9-PP8QGZmDJAXl4,1325
+sqliter/tui/__main__.py,sha256=AYPstbNjxExN1BoPOuOvhOzKKZ25uT6y27FMe8UrOYQ,142
+sqliter/tui/app.py,sha256=D-hveUTrqFOjFTfO66SGmy1Xy_13Cbh03WUJVqHjNkw,5689
+sqliter/tui/demos/__init__.py,sha256=sxrpJ0RQTddL-X-nB_TSjS8HNk5kNIgye1YiRdy8dAE,3014
+sqliter/tui/demos/base.py,sha256=p-C2sV3waLKTVYgqSbO87s2mRUngwTvrPdTea1hXUqo,3343
+sqliter/tui/demos/caching.py,sha256=G0-Yx336rVlY_Hwdn6s9eyIoAQ_iyJvkaMPTryTF30o,8602
+sqliter/tui/demos/connection.py,sha256=xHi9nBFy3nCXDOUgAkF1PfdGTVufqMB3ctVvBYunv4E,4378
+sqliter/tui/demos/constraints.py,sha256=E-RuXOTtD7DywsvBd7QSjTAGkTSm8ef15Y1rKHPLRLY,6468
+sqliter/tui/demos/crud.py,sha256=ltuxUgyhWAxt94FpSs9he_P1YBhI6P1OZpI4g3ueHhg,4112
+sqliter/tui/demos/errors.py,sha256=_WC9ngcfa335nBwCJc3q2WWLnEJqZy20yNYN78PG9rY,6990
+sqliter/tui/demos/field_selection.py,sha256=5wzmIRSxE0CiZoRJN4l2SSyAmn8n7vyL26cDrW8SWVs,4211
+sqliter/tui/demos/filters.py,sha256=4k-0NVUPP-12eHMSt1OKHj88eHbiK_95nX2KilObBOo,11193
+sqliter/tui/demos/models.py,sha256=_jhXLvfWiUd3GuHheAMGmi7eK0prpK3hU2fanoAjBKQ,7129
+sqliter/tui/demos/ordering.py,sha256=IU8rrBXja5rS6_tMHTvcLadc3TBXF2lISNFe5dtuS3Y,4200
+sqliter/tui/demos/orm.py,sha256=AUsUschixnwbHRk717RI9N2c7DSFXZKWiDtaX-hMykY,14892
+sqliter/tui/demos/results.py,sha256=lYVRinbMLSnsm-fDqcs-4vXLzS0j1VmwLWWCPUlUiIE,6830
+sqliter/tui/demos/string_filters.py,sha256=ACq0qsXKwyzZDwkyl1l77-A-1f37T59FahooPDWrMmM,6385
+sqliter/tui/demos/timestamps.py,sha256=6UXnzJsLR6nqMLSKNwjpHOeiHbVp7svgNDc8w9kL5gc,3941
+sqliter/tui/demos/transactions.py,sha256=jYotIzwx2dZSb1aYWQMJeLG7WMlEoHJ3JtuWI49xdKQ,5508
+sqliter/tui/runner.py,sha256=r39oyJzMk7TSmmYFNxeA-sZa-plKcmywPcQUNUNQgy0,3254
+sqliter/tui/styles/app.tcss,sha256=mra0V9P9hPoamAWHQCnPFnWufHYXk58XZHfORz47kV0,1868
+sqliter/tui/widgets/__init__.py,sha256=B9xwBki0O0WonVlh-HBNhHzi55rAx34hMv4-T6Ph4oM,296
+sqliter/tui/widgets/code_display.py,sha256=Ctn7LbMEL0yYEbGtQqTv46XPmky_UA1lbBW4c31HI2k,2173
+sqliter/tui/widgets/demo_list.py,sha256=d017WVyFoQ3tYbf_KW251dLRbPS-0lf-yhWzIVZ56mY,1841
+sqliter/tui/widgets/output_display.py,sha256=VDIGMMijI_yDRm5WUCxMA9FoKlL0ezngqJn1SEih7PE,2641
+sqliter_py-0.16.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+sqliter_py-0.16.0.dist-info/entry_points.txt,sha256=s5eRk657kq0LNqMwAgNH_F93M8aqMeLt122OZ5CQb9s,50
+sqliter_py-0.16.0.dist-info/METADATA,sha256=iCfpNVPJsVnBsIoBc3BV882QsR2Cv_tb4sR8g27hgiE,8011
+sqliter_py-0.16.0.dist-info/RECORD,,

{sqliter_py-0.12.0.dist-info → sqliter_py-0.16.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.21
+Generator: uv 0.9.26
 Root-Is-Purelib: true
-Tag: py3-none-any
+Tag: py3-none-any

sqliter_py-0.16.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sqliter-demo = sqliter.tui:run
+

sqliter_py-0.12.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-sqliter/__init__.py,sha256=ECfn02OPmiMCQvRYbfizKFhVDk00xV-HV1s2cH9037I,244
-sqliter/constants.py,sha256=pNKalajchG6YvXw0-lTMKOJ_OL2xPSs_3YuOuVsqkVk,1257
-sqliter/exceptions.py,sha256=a0Ine1MeHDOjSG3RzMeLVwGfJXrl1YQW4eeUfj6SKJI,6560
-sqliter/helpers.py,sha256=d6k4oWl43Se_c8rAmX8Zj0_sf2O-bpaaeu33VN2IcsI,3442
-sqliter/model/__init__.py,sha256=IZC6you0Wt2o0OovmgBIszt7JzuIY7kMFBpcLwIhcCI,1304
-sqliter/model/foreign_key.py,sha256=aaUJ-02o2_g9JOaxUoicaGTwNwjFS_Si4eYec0bMrqY,5381
-sqliter/model/model.py,sha256=UOD5yO5CizHFWye_BlG28keSK6qWRdHQVI79Y7ovQ9o,8058
-sqliter/model/unique.py,sha256=-Jh56jBv5cjWmZpChwm5jDb_hZBvcqP0gy6MeCNyJvk,827
-sqliter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqliter/query/__init__.py,sha256=MRajhjTPJqjbmmrwndVKj8vqMbK5-XufpwoIswQf5z4,239
-sqliter/query/query.py,sha256=_IDd3tNKogcFYnh-8Ev0Py3SF7G5Igb5VJbhRq4VJPk,30460
-sqliter/sqliter.py,sha256=F3yi816ZkmuzhabhPiCEX7YkoE4Hi3FsjCKKfHKAAlk,38235
-sqliter_py-0.12.0.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
-sqliter_py-0.12.0.dist-info/METADATA,sha256=dP1zmzrNB2J3Sj9u1_UfeDYmqzZneyJPmAD19e22pHM,7623
-sqliter_py-0.12.0.dist-info/RECORD,,