vuer 0.0.24__py3-none-any.whl → 0.0.25__py3-none-any.whl

vuer/__init__.py

@@ -1 +1,13 @@
-from vuer.server import Vuer, VuerSession
+# Conditional import for the pyScript.
+try:
+    from vuer.server import Vuer, VuerSession
+except ImportError:
+    print("""
+    By default, vuer does not include the aiohttp and aiohttp-cors packages
+    to enable installation in PyScript environments. For most usecase, you
+    should install with the [all] option to include all dependencies.
+    
+        pip install 'vuer[all]'
+    
+    Use `'` if using zsh since `[` is a special character.
+    """)

vuer/base.py

@@ -1,11 +1,12 @@
 import asyncio
 import traceback
+import aiohttp_cors
+
 from collections.abc import Coroutine
 from concurrent.futures import CancelledError
 from functools import partial
 from pathlib import Path
 
-import aiohttp_cors
 from aiohttp import web
 from params_proto import Proto
 
@@ -25,8 +26,8 @@ async def websocket_handler(request, handler, **ws_kwargs):
     except ConnectionResetError:
         print("Connection reset")
 
-    except CancelledError as exp:
-        print(f"WebSocket Canceled")
+    except CancelledError:
+        print("WebSocket Canceled")
 
     except Exception as exp:
         print(f"Error:\n{exp}\n{traceback.print_exc()}")
@@ -51,7 +52,7 @@ class Server:
     cors = Proto(help="Enable CORS", default="*")
     port = Proto(env="PORT", default=8012)
 
-    WEBSOCKET_MAX_SIZE = 2**28
+    WEBSOCKET_MAX_SIZE = 2 ** 28
 
     def __post_init__(self):
         self.app = web.Application()
@@ -67,10 +68,10 @@ class Server:
         self.cors_context = aiohttp_cors.setup(self.app, defaults=cors_config)
 
     def _route(
-        self,
-        path: str,
-        handler: callable,
-        method: str = "GET",
+            self,
+            path: str,
+            handler: callable,
+            method: str = "GET",
     ):
         route = self.app.router.add_resource(path).add_route(method, handler)
         self.cors_context.add(route)

vuer/schemas/scene_components.py

@@ -16,6 +16,10 @@ class Scene(BlockElement):
             bgChildren=None,
             # default to y-up to be consistent with three.js. Blender uses z-up though.
             up=[0, 1, 0],
+            # background=None,
+            # bgLight=None,
+            # bgDark=None,
+            # grid=True,
             **kwargs,
     ):
         super().__init__(*children, up=up, **kwargs)
@@ -272,16 +276,22 @@ class Fog(SceneElement):
     Fog is a scene element that adds fog to the scene. This
     can be used to approximate depth.
 
-    Arguments:
-        args: color, near, far
+    Args:
+        color: The color of the fog.
+        near: The distance to the near plane.
+        far: The distance to the far plane.
 
     Example Usage:
-        Fog(args=[0xcccccc, 10, 15])
 
+        Fog(color="green", near=3, far=7)
     """
 
     tag = "fog"
 
+    def __init__(self, *, children=None, color=None, near=None, far=None, **kwargs):
+        assert children is None, "Fog does not support children."
+        super().__init__(attach="fog", key="fog", color=color, near=near, far=far, **kwargs)
+
 
 class Wireframe(SceneElement):
     tag = "Wireframe"

{vuer-0.0.24.dist-info → vuer-0.0.25.dist-info}/METADATA

@@ -1,39 +1,46 @@
 Metadata-Version: 2.1
 Name: vuer
-Version: 0.0.24
+Version: 0.0.25
 Home-page: https://github.com/geyang/vuer
 Author: Ge Yang<ge.ike.yang@gmail.com>
 Author-email: ge.ike.yang@gmail.com
 License: MIT
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python
-Requires-Python: >=3.8.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp
-Requires-Dist: aiohttp-cors
 Requires-Dist: killport
 Requires-Dist: params-proto >=2.11.16
 Requires-Dist: pillow
-Requires-Dist: tqdm
 Requires-Dist: msgpack
 Requires-Dist: numpy
-Requires-Dist: termcolor
-Requires-Dist: trimesh
 Requires-Dist: websockets
+Provides-Extra: all
+Requires-Dist: aiohttp ; extra == 'all'
+Requires-Dist: aiohttp-cors ; extra == 'all'
 Provides-Extra: dev
+Requires-Dist: aiohttp ; extra == 'dev'
+Requires-Dist: aiohttp-cors ; extra == 'dev'
 Requires-Dist: black ==22.3.0 ; extra == 'dev'
 Requires-Dist: pylint ==2.13.4 ; extra == 'dev'
 Requires-Dist: pytest ==7.1.2 ; extra == 'dev'
-
-<h2>Vuer: Modern High-Performance Visualization for AI & Robotics in VR 
+Requires-Dist: sphinx ==7.1.2 ; extra == 'dev'
+Requires-Dist: furo ; extra == 'dev'
+Requires-Dist: sphinx-copybutton ; extra == 'dev'
+Requires-Dist: myst-parser ; extra == 'dev'
+Requires-Dist: termcolor ; extra == 'dev'
+Requires-Dist: trimesh ; extra == 'dev'
+Requires-Dist: tqdm ; extra == 'dev'
+
+<h2>Vuer: Modern High-Performance Visualization for AI & Robotics in VR
 <br/>
 <img src="https://api.netlify.com/api/v1/badges/2df7f3ba-1a26-4047-b76a-d7401f907bb5/deploy-status" alt="Production">
 <a href="https://pypi.org/project/vuer/">
-    <img src="https://img.shields.io/pypi/v/vuer.svg" alt="pypi">
+<img src="https://img.shields.io/pypi/v/vuer.svg" alt="pypi">
 </a>
 <a href="https://docs.vuer.ai">
-    <img src="https://readthedocs.org/projects/vuer-py/badge/?version=latest">
+<img src="https://readthedocs.org/projects/vuer-py/badge/?version=latest">
 </a>
 </h2>
 <p>
@@ -43,9 +50,10 @@ visit &ensp;<a href="https://docs.vuer.ai">https://docs.vuer.ai</a>&ensp; for do
 </p>
 
 Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. It is
-VR and AR ready, and can be run on mobile devices. 
+VR and AR ready, and can be run on mobile devices.
 
 Our features include:
+
 - light-weight and performant
 - VR and AR ready
 - Hackable and extensible
@@ -53,14 +61,14 @@ Our features include:
 
 ## Installation
 
-
 You can install `vuer` with `pip`:
 
 ```shell
-pip install vuer
+pip install -U 'vuer[all]'
 ```
 
-Here is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples, please refer to the [examples](https://docs.vuer.ai/en/latest/examples.html) page.
+Here is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples, please refer to
+the [examples](https://docs.vuer.ai/en/latest/examples.html) page.
 
 ```python
 from vuer import Vuer, VuerSession
@@ -91,9 +99,10 @@ the [API documentation on Components](https://docs.vuer.ai/en/latest/api.html).
 
 For a comprehensive list of data types, please refer to the [API documentation on Data Types](https://docs.vuer.ai/en/latest/api.html).
 
-Now, to run the examples, first download the example datasets. 
+Now, to run the examples, first download the example datasets.
 
-Each subdirectory in the `assets` directory contains a `Makefile`. Run the `make` command in each subdirectory to download the datasets. For example:
+Each subdirectory in the `assets` directory contains a `Makefile`. Run the `make` command in each subdirectory to download the datasets. For
+example:
 
 ```bash
 cd assets/static_3d
@@ -110,11 +119,12 @@ python 01_trimesh.py
 ## Contributing to Documentation and Features
 
 Documentation is a crucial part of the `vuer` ecosystem. To contribute to documentation and usage examples, simply:
+
 ```bash
-cd docs
-pip install -r requirements.txt
+pip install -e '.[dev]'
+make docs
 ```
-
+This should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.
 
 ## About Us
 

{vuer-0.0.24.dist-info → vuer-0.0.25.dist-info}/RECORD

@@ -1,16 +1,16 @@
-vuer/__init__.py,sha256=HMgKfbQAW77ukrMOnE2oKNOYbSNEkBwElpkWxLofvP8,41
-vuer/base.py,sha256=R-PtD39ouihiEGmSfJL26chlU0XkFJP-JmBNYzDdEvM,3068
+vuer/__init__.py,sha256=cP-Ua-bx3mq-3hsnFHAbiGwTnm25hm4wcXp1KhMKCJg,455
+vuer/base.py,sha256=T6zLf21Taknzc8766Af54_iCu1UNdU1cSJDcuDVcqiY,3079
 vuer/events.py,sha256=8AAzkfbm5jHkeMh17Z57n8YTxF4mheWC3Qbya4XkQSc,7291
 vuer/schemas.py,sha256=aZOocE02gO43SLLfeYSxxac0x38TmyTcfs_iFh5hsJ4,18152
 vuer/serdes.py,sha256=gD2iA9Yypu1QjocneOT3Nc0y6q_mdHn9zW1ko5j3I7c,2600
 vuer/server.py,sha256=prJVBaNdWEfz2aIdUDZHY70i34zuQLO63P3F6hSenCk,20889
 vuer/types.py,sha256=N2KLa0fl6z8Jm6cJwZoD8Vqrins_AayG5BCGk1p3Eek,1279
-vuer/__pycache__/__init__.cpython-38.pyc,sha256=rS-9zzAjFEXnObk5q3E5Rex_uvoJ-Ccfz7Hs9DGNVgs,188
+vuer/__pycache__/__init__.cpython-38.pyc,sha256=AGYwJRSMg5cOJ06a6e5KJl20TiGnZjvVjdqlwLMmjLc,188
 vuer/__pycache__/base.cpython-38.pyc,sha256=Z5EFlRX9RqZsQUszvqPtAhLv_5QG5wlUXW7JbFd_XDc,3824
 vuer/__pycache__/events.cpython-38.pyc,sha256=zx3bXeJixqOyCFe2nA7qpq6jiCJ49kRaXO-xONGUyeQ,9616
 vuer/__pycache__/schemas.cpython-38.pyc,sha256=hvY9Aak8zE-zKcWiwuNe6DghOw9qH_zSe_FtkBOAPPk,23234
 vuer/__pycache__/serdes.cpython-38.pyc,sha256=KMxTjPEWuSGn2bqBAl5OLIDSCSoqfPDGfk3fvNnRDYA,2253
-vuer/__pycache__/server.cpython-38.pyc,sha256=efkA35akgB8qZzk-BWgiqrIJigp0AjvLQ6yC-mLX0aA,19641
+vuer/__pycache__/server.cpython-38.pyc,sha256=9VZF8i5IfMkHXR0GrigX1-fJqukfG4TOYkQT6MdnNNA,19641
 vuer/__pycache__/types.cpython-38.pyc,sha256=IhlXtkT-XWM0V1420FDuoqIYnpvRvekYVkGqEK7fAV8,1819
 vuer/addons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerf_vuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -24,14 +24,14 @@ vuer/addons/nerfuer/render_nodes.py,sha256=EJK5N3xne5n7abTaAoLPX7SRqQ_tEen9zNypv
 vuer/schemas/__init__.py,sha256=ZI6UyeLZXqJbHmp6LiE3Q3mHvt1zeV-SJmmcqq-wBZE,94
 vuer/schemas/drei_components.py,sha256=U9svEOnNprhZaobLagaFnqEtZxo5hiriSqjDnvQutoA,6989
 vuer/schemas/html_components.py,sha256=NCqmSPic-ExPrXqNPXbKjtTXMB8sGBywIpE6cXpiy08,5926
-vuer/schemas/scene_components.py,sha256=YeOrbKOScHRLVJ3tZrryLNvj3J1rzQ2vFwF-mCVJf74,16088
+vuer/schemas/scene_components.py,sha256=3u8q2AwgpkkAVifsNXXagmHIvJvWqDwlHCS-QbOwZRM,16540
 vuer/schemas/__pycache__/__init__.cpython-38.pyc,sha256=NRnVrpIDBKne93xOUY1-WpavCG7vwYiqU3VDTEEwuUE,221
 vuer/schemas/__pycache__/drei_components.cpython-38.pyc,sha256=g_ufcKxf-XKfZLdUV-HqKnjIrgxGWFv51aHLWQgH-ws,7712
 vuer/schemas/__pycache__/html_components.cpython-38.pyc,sha256=q0DMFwNkYbnaH1A8w3BowMiQAlmGpFWOOKsjLVE6CIk,8215
-vuer/schemas/__pycache__/scene_components.cpython-38.pyc,sha256=pwFsH7aobrCB-4BSuiLgYxZAa1F_-cw5-6CYr22luAs,19227
-vuer-0.0.24.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
-vuer-0.0.24.dist-info/METADATA,sha256=ud1jfTYVAproqyNFk17mFDIMv9q4ZbWOnGgAHd3130w,4277
-vuer-0.0.24.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-vuer-0.0.24.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
-vuer-0.0.24.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
-vuer-0.0.24.dist-info/RECORD,,
+vuer/schemas/__pycache__/scene_components.cpython-38.pyc,sha256=2jBvnUfJeoy24SMQdYvHzxXL-BwY0cXBCt9LDMk-Nw8,19670
+vuer-0.0.25.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
+vuer-0.0.25.dist-info/METADATA,sha256=bhipMPQyCeX2VbazZyVsFWh_GAG_PsAqQSv88ut2rAo,4754
+vuer-0.0.25.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+vuer-0.0.25.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
+vuer-0.0.25.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
+vuer-0.0.25.dist-info/RECORD,,