h2o-lightwave 1.7.6__py3-none-any.whl

h2o_lightwave/ui_ext.py

@@ -0,0 +1,52 @@
+# Copyright 2020 H2O.ai, Inc.
+#
+# 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.
+
+import json
+from typing import Optional, Union
+
+
+def _clean(d: dict) -> dict:
+    return {k: v for k, v in d.items() if v is not None}
+
+
+def boxes(*args: str) -> str:
+    """Create a specification for card's `box` attribute. Indicates where and how to position a card for various layouts.
+
+    Args:
+        args: Either the name of the zone to place the card in, or a specification created using the `box()` function.
+    Returns:
+        A string intended to be used as a card's `box` attribute.
+    """
+    return json.dumps(args)
+
+
+def box(zone: str, order: Optional[int] = None, size: Optional[Union[str, int]] = None, width: Optional[str] = None,
+        height: Optional[str] = None) -> str:
+    """Create a specification for card's `box` attribute. Indicates where and how to position a card.
+
+    Args:
+        zone: The name of the zone to place the card in.
+        order: An number that determines the position of this card relative to other cards in the same zone. Cards in the same zone are sorted in ascending `order` and then placed left to right (or top to bottom).
+        size: A number that indicates the ratio of available width or height occupied by this card. Defaults to 1 if size, width and height are not provided.
+        width: The width of this card, e.g. `200px`, `50%`, etc.
+        height: The height of this card, e.g. `200px`, `50%`, etc.
+    Returns:
+        A string intended to be used as a card's `box` attribute.
+    """
+    if size is not None:
+        if not isinstance(size, (int, str)):
+            raise ValueError('size must be str or int')
+        if isinstance(size, int):
+            size = str(size)
+    return json.dumps(_clean(dict(zone=zone, order=order, size=size, width=width, height=height)))

h2o_lightwave/version.py

@@ -0,0 +1 @@
+__version__ = '1.7.6'

h2o_lightwave-1.7.6.dist-info/METADATA

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: h2o_lightwave
+Version: 1.7.6
+Summary: H2O Wave Python driver for integration with arbitrary python web frameworks.
+Project-URL: Homepage, https://wave.h2o.ai/
+Project-URL: Documentation, https://wave.h2o.ai/
+Project-URL: Repository, https://github.com/h2oai/wave
+Project-URL: Changelog, https://github.com/h2oai/wave/releases
+Author-email: Martin Turoci <martin.turoci@h2o.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: Data Science,Low code,Machine Learning,Realtime,UI
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Widget Sets
+Requires-Python: >=3.8
+Provides-Extra: web
+Requires-Dist: h2o-lightwave-web==1.7.6; extra == 'web'
+Description-Content-Type: text/markdown
+
+# H2O Lightwave
+
+H2O Lightwave is a lightweight, pure-Python version of [H2O Wave](https://wave.h2o.ai/) that can be embedded in popular async web frameworks like FastAPI, Starlette, etc.
+
+In other words, H2O Lightwave works without the Wave server.
+
+The integration consists of 2 steps:
+
+* Add Wave's web assets directory to your framework's static file handler.
+* Add a webSocket handler, and use `wave_serve()` to connect Wave to your web UI.
+
+That's it. You can now render UI elements using pure Python. Lightwave aims to be as minimal as possible and only provides:
+
+* A simple way to render your UI.
+* A simple way of capturing the user interactions (like button clicks, dropdown values etc.).
+* Minimal state management.
+
+Nothing more, nothing less.
+
+Example FastAPI integration:
+
+```py
+from fastapi import FastAPI, WebSocket, WebSocketDisconnect
+from fastapi.staticfiles import StaticFiles
+from h2o_lightwave import Q, ui, wave_serve
+from h2o_lightwave_web import web_directory
+
+
+# Lightwave callback function.
+async def serve(q: Q):
+    # Paint our UI on the first page visit.
+    if not q.client.initialized:
+        # Create a local state.
+        q.client.count = 0
+        # Add a "card" with a text and a button
+        q.page['hello'] = ui.form_card(box='1 1 2 2', items=[
+            ui.text_xl('Hello world'),
+            ui.button(name='counter', label=f'Current count: {q.client.count}'),
+        ])
+        q.client.initialized = True
+
+    # Handle counter button click.
+    if q.args.counter:
+        # Increment the counter.
+        q.client.count += 1
+        # Update the counter button.
+        q.page['hello'].items[1].button.label = f'Current count: {q.client.count}'
+
+    # Send the UI changes to the browser.
+    await q.page.save()
+
+
+# Run: uvicorn hello_fastapi:app.
+# FastAPI boilerplate.
+app = FastAPI()
+
+
+# FastAPI: WebSocket must be registered before index.html handler.
+@app.websocket("/_s/")
+async def ws(ws: WebSocket):
+    try:
+        await ws.accept()
+        await wave_serve(serve, ws.send_text, ws.receive_text)
+        await ws.close()
+    except WebSocketDisconnect:
+        print('Client disconnected')
+
+app.mount("/", StaticFiles(directory=web_directory, html=True), name="/")
+```
+
+We also recommend reading the [blog post](https://medium.com/@unusualcode/h2o-lightwave-building-web-uis-with-fastapi-and-python-88a915383490) and other [integration examples](https://github.com/h2oai/wave/tree/main/py/h2o_lightwave/examples).
+
+## Installation
+
+```bash
+pip install "h2o-lightwave[web]"
+```
+
+Lightwave requires websockets to function properly. Not all libraries come with them out of the box so you might need to install them additionally. For example, Starlette & FastAPI requires
+
+```bash
+pip install websockets
+```
+
+to be able to expose websocket handlers. This might differ from framework to framework.
+
+## Widgets
+
+All available widgets can be found [here](https://wave.h2o.ai/docs/widgets/overview). We are working on separate docs for Lightwave.
+
+## Custom HTML page
+
+Lightwave can also be used only for certain parts of your HTML pages, e.g. for charts. In addition to the integration steps above:
+
+* Use the `get_web_files` function which HTML links to scripts and styles for you to inject into your existing HTML.
+* Render a `div` with an id `wave-root` (`<div id='wave-root'></div>`) into which you want Lightwave to render.
+* Render a parent container for `wave-root` that has `position: relative` and has some dimensions attached.
+
+```html
+{# index_template.html #}
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Document</title>
+  <!-- Scripts and stylesheets required for Wave to work properly. -->
+  {{ wave_files }}
+</head>
+<style>
+  /* Must have position: relative and some size specified (e.g. height, flexbox, absolute positioning etc.). */
+  .wave-container {
+    position: relative;
+    height: 800px;
+  }
+</style>
+
+<!-- Websocket URL can be changed if needed. Defaults to "/_s/". -->
+<body data-wave-socket-url="/custom_socket/">
+  <noscript>You need to enable JavaScript to run this app.</noscript>
+  <div class="wave-container">
+    <!-- Wave renders here. -->
+    <div id="wave-root"></div>
+  </div>
+</body>
+
+</html>
+```
+
+### Configuration
+
+By default, Lightwave tries to connect to websocket route at `/_s/`. This can be configured by adding a `data-wave-socket-url` attribute on the HTML body element (`<body data-wave-socket-url='/my_socket_url/'>`).
+
+## Links
+
+* Website: [https://wave.h2o.ai/](https://wave.h2o.ai/)
+* Releases: [https://pypi.org/project/h2o-wave/](https://pypi.org/project/h2o-wave/)
+* Code: [https://github.com/h2oai/wave](https://github.com/h2oai/wave)
+* Issue tracker: [https://github.com/h2oai/wave/issues](https://github.com/h2oai/wave/issues)

h2o_lightwave-1.7.6.dist-info/RECORD

@@ -0,0 +1,14 @@
+h2o_lightwave/__init__.py,sha256=gpUT42FqXoR6BwgKHq4Q_yXH_NGtpuN4J9MTjXIVO8s,1140
+h2o_lightwave/core.py,sha256=8jKxQTFC6uAME06XmYcSMwpWaUE7LdAiRnG_i81BN9k,15363
+h2o_lightwave/graphics.py,sha256=HLYrX-lwsMKbyLmy2ClG5L46DA2_hSCEPTsv0gPVoyg,25866
+h2o_lightwave/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+h2o_lightwave/routing.py,sha256=de8GVfUAb6bwFXtsWj6NXmjMVGELknlZb03F-R4ManY,10592
+h2o_lightwave/server.py,sha256=5O55D6LHbX7Xw9mfMhe6ZxHH-fJpOetc5WKQJtDtySU,3850
+h2o_lightwave/types.py,sha256=oEmWG7pl0EyXCSIQQRLOebPTe6oI_nm2HkjGi6Ry5OM,660213
+h2o_lightwave/ui.py,sha256=d9woXqoqJLARvgTsrL1hJ5-iLlwW6HmR7NWriSzK2CA,172443
+h2o_lightwave/ui_ext.py,sha256=zx_2Ec2-p_ztm8brfVaVF0fTQWVDrb_YxcGfVb-wA10,2325
+h2o_lightwave/version.py,sha256=vMMj4nitlrBKFmTUAadBb7pmN17PH90b7xP_hpzRg9U,22
+h2o_lightwave-1.7.6.dist-info/METADATA,sha256=9kByskOuXW54b19vOIenRfk8qQu4KZDsPZZYSt2dfXM,6323
+h2o_lightwave-1.7.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+h2o_lightwave-1.7.6.dist-info/licenses/LICENSE,sha256=hpuFayniDwysSKD0tHGELH2KJDVyhUrKS29torRIpqY,53
+h2o_lightwave-1.7.6.dist-info/RECORD,,

h2o_lightwave-1.7.6.dist-info/WHEEL

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

h2o_lightwave-1.7.6.dist-info/licenses/LICENSE

@@ -0,0 +1 @@
+Copyright (c) 2020 H2O.ai, Inc - All Rights Reserved