pyxflow 0.4.0__tar.gz

pyxflow-0.4.0/.gitignore

@@ -0,0 +1,51 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+/build/
+/bundle-project/
+# Keep src/pyxflow/bundle/ (Vaadin frontend assets shipped in wheel)
+!src/pyxflow/bundle/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Playwright
+.playwright-mcp/
+
+# Logs
+*.log
+
+# OS
+.DS_Store
+Thumbs.db

pyxflow-0.4.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Vaadin Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyxflow-0.4.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: pyxflow
+Version: 0.4.0
+Summary: Python implementation of Vaadin Flow
+Project-URL: Homepage, https://github.com/manolo/pyxflow
+Project-URL: Documentation, https://vaadin.com/docs
+Author-email: Vaadin <info@vaadin.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: User Interfaces
+Requires-Python: >=3.10
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: watchfiles>=0.20
+Provides-Extra: dev
+Requires-Dist: pillow; extra == 'dev'
+Requires-Dist: playwright; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-playwright; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: pyyaml; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<img src="docs/logo.png" alt="PyXFlow" width="80" align="left" style="margin-right: 16px;">
+
+# [PyXFlow](https://manolo.github.io/pyxflow/)
+
+**Build full-stack web apps in pure Python. No JavaScript. No HTML templates.**
+
+Write your code and business logic in Python. It runs on the server. The browser is just a thin client rendering standard web components: you never touch the frontend.
+
+Under the hood, PyXFlow uses the same server-driven architecture as [Vaadin Flow](https://vaadin.com/flow) but entirely written in Python, and ships with 50+ [Vaadin web components](https://vaadin.com/components): enterprise-grade, accessible, and battle-tested over years.
+
+<p align="center">
+  <img src="docs/screenshots/architecture-diagram.png" alt="Architecture">
+</p>
+
+---
+
+```python
+from pyxflow import Route
+from pyxflow.components import *
+
+@Route("hello")
+class HelloView(HorizontalLayout):
+    def __init__(self):
+        name = TextField("Your name")
+        button = Button("Say hello", lambda e: Notification.show(f"Hello {name.value}"))
+        self.add(name, button)
+```
+
+<p align="center">
+  <img src="docs/screenshots/screenshot-hello-crop.gif" alt="Hello World" width="500">
+</p>
+
+## Features
+
+- **Server-side only** -- all logic runs in Python, no JavaScript to write
+- **Real-time push** -- update the UI from background tasks via WebSocket
+- **Lazy data loading** -- Grid with virtual scrolling and server-side sorting
+- **Form validation** -- Binder with validators and converters
+- **Theming** -- Lumo and Aura themes with dark mode support
+- **Hot reload** -- `--dev` mode watches for file changes
+
+## Demo
+
+The included demo app showcases real-world patterns across 8 views:
+
+| View | Route | What it shows |
+|------|-------|---------------|
+| About | `/` | Landing page with logo and architecture diagram |
+| Hello | `/hello` | Simplest view -- TextField + Button + Notification |
+| Components | `/components` | 20+ components in a responsive CSS grid |
+| Grid | `/grid` | Lazy data provider with sorting and selection (200 rows) |
+| Master-Detail | `/master-detail` | Grid + side form with Binder validation |
+| Responsive CRUD | `/crud` | Full CRUD with route parameters and FAB |
+| Stopwatch | `/push-demo` | WebSocket push -- server updates UI every second |
+| File Explorer | `/file-explorer` | TreeGrid + @ClientCallable for server method calls |
+
+<p align="center">
+  <img src="docs/screenshots/demo-tour.gif" alt="Demo tour" width="700">
+</p>
+
+### Run the demo
+
+```bash
+git clone https://github.com/manolo/pyxflow.git
+cd pyxflow
+python -m venv .venv && source .venv/bin/activate
+pip install -e .
+python -m demo          # http://localhost:8088
+```
+
+## Installation
+
+```bash
+pip install pyxflow
+```
+
+## Quick start
+
+```bash
+mkdir my-app && cd my-app
+python -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install pyxflow
+pyxflow --setup
+pyxflow
+# http://localhost:8080
+```
+
+This scaffolds a project with `views/`, `static/`, and VSCode config:
+
+```
+my-app/
+  views/
+    main_layout.py    # AppLayout with SideNav
+    hello_world.py    # Sample view with TextField + Button
+  static/
+    favicon.ico
+    styles/
+      styles.css
+    images/
+  .vscode/            # VSCode settings, snippets, extensions
+```
+
+### Running
+
+```bash
+pyxflow [app_module] [options]
+
+  app_module               Python module with views/ (auto-detected if omitted)
+  --setup [app_name]       Scaffold a new project (views, static, .vscode/)
+  --vscode                 Generate .vscode/ config and install recommended extensions
+  --dev                    Auto-reload on source changes
+  --debug                  Verbose UIDL protocol logging
+  --port PORT              Server port (default: 8080)
+  --host HOST              Server host (default: localhost)
+  --bundle                 Generate frontend bundle
+```
+
+## Routing
+
+Each view is a Python class with a `@Route` decorator that defines the URL path. Add `@Menu` to include it in the navigation. PyXFlow handles client-side URL routing automatically.
+
+```python
+from pyxflow import Route, Menu
+
+@Route("dashboard", page_title="Dashboard", layout=MainLayout)
+@Menu(title="Dashboard", order=1, icon="vaadin:dashboard")
+class DashboardView(VerticalLayout):
+    ...
+```
+
+- `@Route(path)` -- register a view at a URL path
+- `@Route(path, layout=MainLayout)` -- wrap in a layout
+- `@Menu(title, order, icon)` -- add to the navigation menu
+- Route parameters: `@Route("greet/:name")` with `on_parameter_changed(self, params)`
+
+## Application shell
+
+`@AppShell` marks the global app configuration: push, theme, stylesheets. Only one per app. In practice, you put it on your main layout class (`AppLayout`) which provides the navbar, drawer, and content area.
+
+```python
+from pyxflow import AppShell, Push, ColorScheme, StyleSheet
+from pyxflow.components import AppLayout, DrawerToggle, H1, SideNav, SideNavItem
+from pyxflow.menu import get_menu_entries
+
+@AppShell
+@Push
+@ColorScheme("dark")
+@StyleSheet("lumo/lumo.css", "styles/styles.css")
+class MainLayout(AppLayout):
+    def __init__(self):
+        self.add_to_navbar(DrawerToggle(), H1("My App"))
+        nav = SideNav()
+        for entry in get_menu_entries():
+            nav.add_item(SideNavItem(entry.title, entry.path))
+        self.add_to_drawer(nav)
+```
+
+## Grid with lazy data
+
+Grid fetches only the rows visible in the viewport. Provide a callback that returns a slice of your data and the total count -- Grid handles virtual scrolling, sorting, and pagination.
+
+```python
+grid = Grid()
+grid.add_column("name", header="Name").set_sortable(True).set_auto_width(True)
+grid.add_column("email", header="Email").set_auto_width(True)
+grid.set_data_provider(my_fetch)
+
+def my_fetch(offset, limit, sort_orders):
+    return items[offset:offset+limit], len(items)
+```
+
+## Real-time push
+
+Update the UI from business background tasks running in the server. The server pushes changes to the browser via WebSocket. Just call `ui.access()` from any async task.
+
+```python
+import asyncio
+
+@Route("live")
+class LiveView(VerticalLayout):
+    def __init__(self):
+        self.label = Span("0")
+        self.add(self.label)
+        asyncio.get_event_loop().create_task(self._tick())
+
+    async def _tick(self):
+        n = 0
+        while True:
+            await asyncio.sleep(1)
+            n += 1
+            ui = self.get_ui()
+            if ui:
+                ui.access(lambda: self.label.set_text(str(n)))
+```
+
+Requires `@Push` on the `@AppShell` class.
+
+## Components
+
+<p align="center">
+  <img src="docs/screenshots/screenshot-components.gif" alt="Components" width="650">
+</p>
+
+| Type | Component | Description |
+|------|-----------|-------------|
+| Input | `TextField` | Single-line text input |
+| Input | `TextArea` | Multi-line text input |
+| Input | `PasswordField` | Masked password input |
+| Input | `EmailField` | Email input with RFC 5322 validation |
+| Input | `NumberField` | Numeric input with min/max/step |
+| Input | `IntegerField` | Integer-only variant |
+| Input | `Checkbox` / `CheckboxGroup` | Toggle and multiple selection |
+| Input | `RadioButtonGroup` | Single selection from options |
+| Input | `Select` | Dropdown single selection |
+| Input | `ComboBox` / `MultiSelectComboBox` | Filterable dropdown (multi-select) |
+| Input | `DatePicker` / `TimePicker` / `DateTimePicker` | Date and time selection |
+| Input | `Upload` | File upload |
+| Input | `CustomField` | Composite custom field |
+| Data | `Grid` | Data table with sorting, selection, lazy loading, renderers |
+| Data | `TreeGrid` | Hierarchical data table with expand/collapse |
+| Layout | `VerticalLayout` / `HorizontalLayout` | Stack children vertically or horizontally |
+| Layout | `FlexLayout` | CSS Flexbox layout |
+| Layout | `FormLayout` | Responsive form with labels and colspan |
+| Layout | `SplitLayout` | Resizable two-panel split |
+| Layout | `AppLayout` | Application shell with navbar and drawer |
+| Layout | `Scroller` | Scrollable container |
+| Layout | `Card` | Styled card container |
+| Layout | `Details` / `Accordion` | Collapsible sections |
+| Layout | `Dialog` / `ConfirmDialog` | Modal dialogs |
+| Layout | `MasterDetailLayout` | Master-detail pattern |
+| Navigation | `Tabs` / `TabSheet` | Tab navigation with content panels |
+| Navigation | `SideNav` | Side navigation with items |
+| Navigation | `MenuBar` / `ContextMenu` | Hierarchical and right-click menus |
+| Navigation | `RouterLink` | Client-side navigation link |
+| Display | `Button` | Click listener, icon support, keyboard shortcuts |
+| Display | `Icon` | Vaadin and Lumo icon sets |
+| Display | `Notification` | Toast notifications with position and duration |
+| Display | `ProgressBar` | Determinate and indeterminate progress |
+| Display | `Avatar` / `AvatarGroup` | User avatars |
+| Display | `Span`, `H1`-`H6`, `Paragraph`, `Pre` | Text elements |
+| Display | `Image`, `Anchor`, `IFrame` | Media and links |
+
+## Development
+
+See [README-DEV.md](README-DEV.md) for setup, tests, project structure, and architecture.
+
+## License
+
+Apache License 2.0