vuer 0.0.13rc2__py3-none-any.whl → 0.0.14__py3-none-any.whl

vuer/__init__.py

@@ -0,0 +1 @@
+from vuer.server import Vuer, VuerSession

vuer/server.py

@@ -23,7 +23,8 @@ from vuer.events import (
     Remove,
     Add,
     ServerRPC,
-    GrabRender, Upsert,
+    GrabRender,
+    Upsert,
 )
 from vuer.schemas import Page
 from vuer.types import EventHandler, Spawnable
@@ -44,7 +45,7 @@ class At:
         return self.fn(*args, **kwargs)
 
 
-class VuerProxy:
+class VuerSession:
     def __init__(self, vuer: "Vuer", ws_id: int, queue_len=100):
         self.vuer = vuer
         self.CURRENT_WS_ID = ws_id
@@ -85,7 +86,9 @@ class VuerProxy:
         :param subsample: The subsample of the render.
         :param ttl: The time to live for the handler. If the handler is not called within the time it gets removed from the handler list.
         """
-        assert self.CURRENT_WS_ID is not None, "Websocket session is missing. CURRENT_WS_ID is None."
+        assert (
+            self.CURRENT_WS_ID is not None
+        ), "Websocket session is missing. CURRENT_WS_ID is None."
 
         event = GrabRender(**kwargs)
 
@@ -219,10 +222,12 @@ class VuerProxy:
     def stream(self):
         yield from self.downlink_queue
 
+
 class Vuer(PrefixProto, Server):
     """
     A Vuer is a document that can be rendered in a browser.
     """
+
     name = "vuer"
     uri = "ws://localhost:8012"
     # change to vuer.dash.ml
@@ -240,7 +245,7 @@ class Vuer(PrefixProto, Server):
 
     # need to be awaited
 
-    def _proxy(self, ws_id) -> "VuerProxy":
+    def _proxy(self, ws_id) -> "VuerSession":
         """This is a proxy object that allows us to use the @ notation
         to send events to the client.
 
@@ -248,7 +253,7 @@ class Vuer(PrefixProto, Server):
         :return: A proxy object.
         """
         # todo: check if shallow copy suffices
-        proxy = VuerProxy(self, ws_id, queue_len=self.queue_len)
+        proxy = VuerSession(self, ws_id, queue_len=self.queue_len)
 
         return proxy
 
@@ -282,7 +287,7 @@ class Vuer(PrefixProto, Server):
         """
         # todo: need to implement msgpack encoding, interface
         bytes = request.bytes()
-        session_id = request.rel_url.query.get('sid', None)
+        session_id = request.rel_url.query.get("sid", None)
         if session_id is None:
             return Response(400)
         elif session_id in self.ws:
@@ -301,7 +306,7 @@ class Vuer(PrefixProto, Server):
             return Response(status=400)
 
     # ** downlink message queue methods**
-    async def bound_fn(self, session_proxy: VuerProxy):
+    async def bound_fn(self, session_proxy: VuerSession):
         """This is the default generator function in the socket connection handler"""
         print("default socket worker is up, adding clientEvents ")
         session_proxy.downlink_queue.append(INIT)
@@ -330,7 +335,6 @@ class Vuer(PrefixProto, Server):
 
             session_proxy.downlink_queue.append(client_event)
 
-
     def spawn_task(self, task):
         loop = asyncio.get_running_loop()
         return loop.create_task(task)
@@ -419,7 +423,7 @@ class Vuer(PrefixProto, Server):
         response = None
 
         async def response_handler(
-                response_event: ClientEvent, _: "VuerProxy"
+            response_event: ClientEvent, _: "VuerSession"
         ) -> Coroutine:
             nonlocal response
 
@@ -454,8 +458,7 @@ class Vuer(PrefixProto, Server):
         except KeyError:
             pass
 
-    async def uplink(self, proxy: VuerProxy):
-
+    async def uplink(self, proxy: VuerSession):
         ws_id = proxy.CURRENT_WS_ID
         queue = proxy.uplink_queue
 
@@ -522,7 +525,6 @@ class Vuer(PrefixProto, Server):
 
         try:
             async for msg in ws:
-
                 payload = unpackb(msg.data, raw=False)
                 clientEvent = ClientEvent(**payload)
 
@@ -553,10 +555,10 @@ class Vuer(PrefixProto, Server):
             self.ws.pop(ws_id, None)
 
     def add_handler(
-            self,
-            event_type: str,
-            fn: EventHandler,
-            once: bool = False,
+        self,
+        event_type: str,
+        fn: EventHandler,
+        once: bool = False,
     ) -> Callable[[], None]:
         """Adding event handlers to the vuer server.
 
@@ -609,12 +611,10 @@ class Vuer(PrefixProto, Server):
             kill_ports(ports=[self.port])
             time.sleep(0.01)
 
-        # host = host[2:]
-
         self._socket("", self.downlink)
         # serve local files via /static endpoint
         self._static("/static", self.static_root)
         print("serving static files from", self.static_root, "at", "/static")
         self._route("/relay", self.relay, method="POST")
-        # self._socket()
+
         super().run()

vuer-0.0.14.dist-info/METADATA

@@ -0,0 +1,115 @@
+Metadata-Version: 2.1
+Name: vuer
+Version: 0.0.14
+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
+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: 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'
+
+# Welcome to `Vuer`  
+
+[![PyPI version fury.io](https://badge.fury.io/py/vuer.svg)](https://pypi.python.org/pypi/vuer/)
+
+![Production](https://api.netlify.com/api/v1/badges/2df7f3ba-1a26-4047-b76a-d7401f907bb5/deploy-status)
+
+![Staging](https://api.netlify.com/api/v1/badges/1727476e-c992-4dc1-98bf-92ef266cad78/deploy-status)
+
+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.
+
+## Installation
+
+You can install `vuer` with `pip`:
+
+```shell
+pip install vuer
+```
+
+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
+from vuer.schemas import DefaultScene, Urdf
+
+app = Vuer()
+
+
+@app.spawn(start=True)
+async def main(session: VuerSession):
+    app.set @ DefaultScene(
+        Urdf("assets/urdf/robotiq.urdf"),
+    )
+
+    while True:
+        await session.sleep(0.1)
+```
+
+<iframe src="https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q" width="100%" height="400px" frameborder="0"></iframe>
+
+Vuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.
+
+- light-weight and performant
+- VR and AR ready
+- has a strong community support
+- Hackable and extensible
+- Open source, licensed under MIT
+
+To get a quick overview of what you can do with  <code style="font-size: 1.3em; background-clip: text; color: transparent; background-image: linear-gradient(to right, rgb(0,140,220), rgb(226,213,79), rgb(210,0,12));">vuer</code>, check out the following:
+
+- take a look at the example gallery [here](https://docs.vuer.ai/en/latest/examples.html)
+- or try to take a look at this demo [here](https://docs.vuer.ai/en/latest/examples.html#demo)
+
+For a comprehensive list of visualization components, please refer to
+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. 
+
+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
+make
+```
+
+Then run the examples
+
+```bash
+cd vuer/examples/vuer
+python 01_trimesh.py
+```
+
+## To Develop
+
+### Setting up the Document Site
+
+https://www.docslikecode.com/learn/05-cd-for-docs/
+
+```bash
+cd docs
+pip install -r requirements.txt
+```
+
+
+

{vuer-0.0.13rc2.dist-info → vuer-0.0.14.dist-info}/RECORD

@@ -1,16 +1,16 @@
-vuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vuer/__init__.py,sha256=HMgKfbQAW77ukrMOnE2oKNOYbSNEkBwElpkWxLofvP8,41
 vuer/base.py,sha256=mODsrpH8qePkfVjx5rXdXs7xjt2zpjcSOs_jzUpNbLI,3051
 vuer/events.py,sha256=hPCCGZxL090rz3u_ySB_vFB0d7tgOwdQVPNL487z37k,7069
 vuer/schemas.py,sha256=GRWe52b1A-AvtDurilxa2xfCrpUE1tBns6KqigYfE5o,14402
 vuer/serdes.py,sha256=_4q65iHmIW-Op5OCvNwgAy7Z4ofOcvuW3NfTbRfiuZo,2398
-vuer/server.py,sha256=GAoUv12eIESl4xwN66I2Bw9iNCt8ZQaNwDcibc_OpRQ,18553
+vuer/server.py,sha256=i-ShDfxAr5KBXtgCTLDbbqpj1ExjaAROF_mv4P0jOSM,18521
 vuer/types.py,sha256=YpRQrBzB2uGM1Lhu8eSaBGB88IgSnY4Czl5cgthxGkM,1003
-vuer/__pycache__/__init__.cpython-38.pyc,sha256=552emB1vL_-Yy1EhBJ-dwKjJq-w2Q2qvImI8tmUpIsI,136
+vuer/__pycache__/__init__.cpython-38.pyc,sha256=rS-9zzAjFEXnObk5q3E5Rex_uvoJ-Ccfz7Hs9DGNVgs,188
 vuer/__pycache__/base.cpython-38.pyc,sha256=cxwPAy8hWCo5t9TaTaaT1gs2MpByDbAOKCMVbqVldds,3930
 vuer/__pycache__/events.cpython-38.pyc,sha256=7NT7W5ObDyCz542mhDQkLWYzMOIP0Ihx7syjnJZT6lE,9409
 vuer/__pycache__/schemas.cpython-38.pyc,sha256=D0fWjYOBNPSbQkH_aR_-yOz4BZcgflUB6c6TjnTt2DI,19936
 vuer/__pycache__/serdes.cpython-38.pyc,sha256=oT1A94H8ayRCxNnw0L-7Q5Dt3535MOwXZMkvyQQvB9M,2032
-vuer/__pycache__/server.cpython-38.pyc,sha256=HuV-fzxh0siyjgj8g5xh5BLGAecNp2-6Hf7Hn_MZhEc,17276
+vuer/__pycache__/server.cpython-38.pyc,sha256=aup7KkU3-iKB4LZKQRHmABOd7NQMw-iCNhl1geH4Um4,17318
 vuer/__pycache__/types.cpython-38.pyc,sha256=eM6bZ35nB-AYALbZXf9goHjLoHxllqbIwHloi0yCOeA,1868
 vuer/addons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerf_vuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,9 +21,9 @@ vuer/addons/nerf_vuer/render_components.py,sha256=XilHnJySJWVgmdUbPFNYyc_YWV8O5A
 vuer/addons/nerf_vuer/render_nodes.py,sha256=5TKqIbMPiOtBxfF4FQI6uB0w_9FTfGiwS8xRbhPa0_g,14441
 vuer/addons/nerfuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerfuer/render_nodes.py,sha256=EJK5N3xne5n7abTaAoLPX7SRqQ_tEen9zNypvSnZTTw,4465
-vuer-0.0.13rc2.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
-vuer-0.0.13rc2.dist-info/METADATA,sha256=VsQP1rdqdgMHZxVb1BYvRXL6ScuXriglDga7Wp4USpo,1695
-vuer-0.0.13rc2.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-vuer-0.0.13rc2.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
-vuer-0.0.13rc2.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
-vuer-0.0.13rc2.dist-info/RECORD,,
+vuer-0.0.14.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
+vuer-0.0.14.dist-info/METADATA,sha256=mn3k4HNequJaEJ4L3hPU3NcxJhbxy4bOH34IGtAhWRM,4122
+vuer-0.0.14.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+vuer-0.0.14.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
+vuer-0.0.14.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
+vuer-0.0.14.dist-info/RECORD,,

vuer-0.0.13rc2.dist-info/METADATA

@@ -1,80 +0,0 @@
-Metadata-Version: 2.1
-Name: vuer
-Version: 0.0.13rc2
-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
-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: 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'
-
-# Vuer: A modern 3D Visualizer for Robotics and VR
-
-Vuer is a 3D visualization tool for robotics and VR applications.
-
-## Installation In A Fresh Conda Environment
-
-Setup the conda environment
-```bash
-conda create -n vuer python=3.8
-conda activate vuer
-```
-
-Install vuer
-```bash
-pip install vuer==0.0.9
-
-pip install numpy
-pip install trimesh
-pip install websockets
-pip install aiohttp-cors
-pip install pillow
-```
-
-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:
-
-```bash
-cd assets/static_3d
-make
-```
-
-Then run the examples
-
-```bash
-cd vuer/examples/vuer
-python 01_trimesh.py
-```
-
-## To Develop
-
-### Setting up the Document Site
-
-https://www.docslikecode.com/learn/05-cd-for-docs/
-
-```bash
-cd docs
-pip install -r requirements.txt
-```
-
-
-