vuer 0.0.50__tar.gz

vuer-0.0.50/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ge Yang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vuer-0.0.50/MANIFEST.in

@@ -0,0 +1,2 @@
+include VERSION
+recursive-include vuer/ *.*

vuer-0.0.50/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: vuer
+Version: 0.0.50
+Home-page: https://github.com/vuer-ai/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.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: params-proto>=2.13.0
+Requires-Dist: pillow
+Requires-Dist: msgpack
+Requires-Dist: numpy>=1.21
+Requires-Dist: websockets
+Provides-Extra: all
+Requires-Dist: aiohttp==3.10.5; extra == "all"
+Requires-Dist: aiohttp-cors; extra == "all"
+Requires-Dist: killport; extra == "all"
+Provides-Extra: example
+Requires-Dist: aiohttp==3.10.5; extra == "example"
+Requires-Dist: aiohttp-cors; extra == "example"
+Requires-Dist: killport; extra == "example"
+Requires-Dist: open3d<0.16.0,>=0.15.0; extra == "example"
+Requires-Dist: trimesh; extra == "example"
+Requires-Dist: cmx; extra == "example"
+Requires-Dist: functional_notations; extra == "example"
+Requires-Dist: ml_logger; extra == "example"
+Requires-Dist: opencv-python; extra == "example"
+Provides-Extra: dev
+Requires-Dist: cmx; extra == "dev"
+Requires-Dist: aiohttp==3.10.5; extra == "dev"
+Requires-Dist: aiohttp-cors; extra == "dev"
+Requires-Dist: killport; extra == "dev"
+Requires-Dist: pylint==2.13.4; extra == "dev"
+Requires-Dist: pytest==7.1.2; extra == "dev"
+Requires-Dist: sphinx==7.1.2; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Requires-Dist: sphinx-autobuild; extra == "dev"
+Requires-Dist: sphinx_copybutton; extra == "dev"
+Requires-Dist: sphinxcontrib-video; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Requires-Dist: trimesh; extra == "dev"
+Requires-Dist: tqdm; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license-file
+
+<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">
+</a>
+<a href="https://docs.vuer.ai">
+<img src="https://readthedocs.org/projects/vuer-py/badge/?version=latest">
+</a>
+</h2>
+<p>
+<strong><code>pip install vuer</code></strong>
+&nbsp;&nbsp;⬝&nbsp;&nbsp;
+visit &ensp;<a href="https://docs.vuer.ai">https://docs.vuer.ai</a>&ensp; for documentation
+</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.
+
+Our features include:
+
+- light-weight and performant
+- VR and AR ready
+- Hackable and extensible
+- Open source, licensed under MIT
+
+## Installation
+
+You can install `vuer` with `pip`:
+
+```shell
+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/01_trimesh.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)
+```
+
+[![Click for Live Demo](./assets/curiosity.png)](https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q")
+
+To get a quick overview of what you can do with `vuer`, check out the following:
+
+- take a look at the example gallery [here](https://docs.vuer.ai/en/latest/examples/01_trimesh.html)
+- or try to take a look at this demo with a Unitree Go1 robot in front of a flight of stairs [here](https://docs.vuer.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html)
+
+For a comprehensive list of visualization components, please refer to
+the [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).
+
+For a comprehensive list of data types, please refer to the [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.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
+```
+
+## Contributing to Documentation and Features
+
+Documentation is a crucial part of the `vuer` ecosystem. To contribute to documentation and usage examples, simply:
+
+```bash
+pip install -e '.[all]'
+make docs
+```
+This should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.
+
+## To Cite
+
+```bibtex
+@software{vuer,
+  author = {Ge Yang},
+  title = {{VUER}: A 3D Visualization and Data Collection Environment for Robot Learning},
+  version = {},
+  publisher = {GitHub},
+  url = {https://github.com/vuer-ai/vuer},
+  year = {2024}
+}
+```
+
+## About Us
+
+Vuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.
+
+
+

vuer-0.0.50/README

@@ -0,0 +1,135 @@
+.. raw:: html
+
+   <h2>
+
+Vuer: Modern High-Performance Visualization for AI & Robotics in VR
+
+.. raw:: html
+
+   </h2>
+
+.. raw:: html
+
+   <p>
+
+pip install vuer   ⬝   visit  https://docs.vuer.ai  for documentation
+
+.. raw:: html
+
+   </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.
+
+Our features include:
+
+-  light-weight and performant
+-  VR and AR ready
+-  Hackable and extensible
+-  Open source, licensed under MIT
+
+Installation
+============
+
+You can install ``vuer`` with ``pip``:
+
+.. code-block:: shell
+
+   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/01_trimesh.html>`__
+page.
+
+.. code-block:: 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)
+
+|Click for Live Demo|
+
+To get a quick overview of what you can do with ``vuer``, check out the
+following:
+
+-  take a look at the example gallery
+   `here <https://docs.vuer.ai/en/latest/examples/01_trimesh.html>`__
+-  or try to take a look at this demo with a Unitree Go1 robot in front
+   of a flight of stairs
+   `here <https://docs.vuer.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html>`__
+
+For a comprehensive list of visualization components, please refer to
+the `API documentation on
+Components <https://docs.vuer.ai/en/latest/api/vuer.html>`__.
+
+For a comprehensive list of data types, please refer to the `API
+documentation on Data
+Types <https://docs.vuer.ai/en/latest/api/types.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:
+
+.. code-block:: bash
+
+   cd assets/static_3d
+   make
+
+Then run the examples
+
+.. code-block:: bash
+
+   cd vuer/examples/vuer
+   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:
+
+.. code-block:: bash
+
+   pip install -e '.[all]'
+   make docs
+
+This should fire up an http server at the port ``8888``, and you can
+view the documentation at ``http://localhost:8888``.
+
+To Cite
+=======
+
+.. code-block:: bibtex
+
+   @software{vuer,
+     author = {Ge Yang},
+     title = {{VUER}: A 3D Visualization and Data Collection Environment for Robot Learning},
+     version = {},
+     publisher = {GitHub},
+     url = {https://github.com/vuer-ai/vuer},
+     year = {2024}
+   }
+
+About Us
+========
+
+Vuer is built by researchers at MIT and UCSD in fields including
+robotics, computer vision, and computer graphics.
+
+.. |Click for Live Demo| image:: https://github.com/geyang/vuer/blob/master/assets/curiosity.png?raw=true
+   :target: https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q%22

vuer-0.0.50/README.md

@@ -0,0 +1,112 @@
+<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">
+</a>
+<a href="https://docs.vuer.ai">
+<img src="https://readthedocs.org/projects/vuer-py/badge/?version=latest">
+</a>
+</h2>
+<p>
+<strong><code>pip install vuer</code></strong>
+&nbsp;&nbsp;⬝&nbsp;&nbsp;
+visit &ensp;<a href="https://docs.vuer.ai">https://docs.vuer.ai</a>&ensp; for documentation
+</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.
+
+Our features include:
+
+- light-weight and performant
+- VR and AR ready
+- Hackable and extensible
+- Open source, licensed under MIT
+
+## Installation
+
+You can install `vuer` with `pip`:
+
+```shell
+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/01_trimesh.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)
+```
+
+[![Click for Live Demo](./assets/curiosity.png)](https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q")
+
+To get a quick overview of what you can do with `vuer`, check out the following:
+
+- take a look at the example gallery [here](https://docs.vuer.ai/en/latest/examples/01_trimesh.html)
+- or try to take a look at this demo with a Unitree Go1 robot in front of a flight of stairs [here](https://docs.vuer.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html)
+
+For a comprehensive list of visualization components, please refer to
+the [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).
+
+For a comprehensive list of data types, please refer to the [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.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
+```
+
+## Contributing to Documentation and Features
+
+Documentation is a crucial part of the `vuer` ecosystem. To contribute to documentation and usage examples, simply:
+
+```bash
+pip install -e '.[all]'
+make docs
+```
+This should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.
+
+## To Cite
+
+```bibtex
+@software{vuer,
+  author = {Ge Yang},
+  title = {{VUER}: A 3D Visualization and Data Collection Environment for Robot Learning},
+  version = {},
+  publisher = {GitHub},
+  url = {https://github.com/vuer-ai/vuer},
+  year = {2024}
+}
+```
+
+## About Us
+
+Vuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.
+
+
+

vuer-0.0.50/VERSION

@@ -0,0 +1 @@
+0.0.50

vuer-0.0.50/pyproject.toml

@@ -0,0 +1,114 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vuer"
+version = "0.0.50"
+description = ""
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.7"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python",
+]
+dependencies = [
+    "params-proto>=2.13.0",
+    "pillow",
+    "msgpack",
+    "numpy>=1.21", # because we require numpy.typing.NDArray
+    "websockets",
+]
+
+[project.optional-dependencies]
+# add the cors package, not needed in pyScript
+all = [
+    "aiohttp==3.10.5",
+    "aiohttp-cors",
+    "killport",
+]
+example = [
+    "aiohttp==3.10.5",
+    "aiohttp-cors",
+    "killport",
+    "open3d>=0.15.0,<0.16.0",
+    "trimesh",
+    "cmx",
+    "functional_notations",
+    "ml_logger",
+    "opencv-python"
+]
+dev = [
+    "cmx",
+    "aiohttp==3.10.5",
+    "aiohttp-cors",
+    "killport",
+    "pylint==2.13.4",
+    "pytest==7.1.2",
+    "sphinx==7.1.2",
+    "furo",
+    "sphinx-autobuild",
+    "sphinx_copybutton",
+    "sphinxcontrib-video",
+    "myst_parser",
+    # these are very optional but needed for the doc site
+    "trimesh",
+    "tqdm",
+]
+
+[project.scripts]
+# Note, add the entrypoint name to scripts/completions/install.py to include CLI percentage
+vuer = "vuer:entrypoint"
+
+[tool.setuptools.packages.find]
+include = ["vuer*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.json"]
+
+# black
+[tool.black]
+line-length = 120
+
+# pylint
+[tool.pylint.messages_control]
+max-line-length = 120
+generated-members = []
+good-names-rgxs = "^[_a-zA-Z][_a-z0-9]?$"
+ignore-paths = []
+jobs = 0
+ignored-classes = ["TensorDataclass"]
+
+disable = [
+    "duplicate-code",
+    "fixme",
+    "logging-fstring-interpolation",
+    "too-many-arguments",
+    "too-many-branches",
+    "too-many-instance-attributes",
+    "too-many-locals",
+    "unnecessary-ellipsis",
+]
+
+#pytest
+#[tool.pytest.ini_options]
+#addopts = "-n=4 --typeguard-packages=vuer --disable-warnings"
+#testpaths = [
+#    "tests",
+#]
+
+# pyright
+[tool.pyright]
+include = ["vuer"]
+exclude = ["**/node_modules", "**/__pycache__", ]
+#ignore = ["nerf_vuer"]
+defineConstant = { DEBUG = true }
+
+reportMissingImports = true
+reportMissingTypeStubs = false
+reportPrivateImportUsage = false
+reportUndefinedVariable = false
+
+#pythonVersion = "3.8"
+#pythonPlatform = "Linux"

vuer-0.0.50/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vuer-0.0.50/setup.py

@@ -0,0 +1,27 @@
+from os import path
+from setuptools import setup, find_packages
+
+with open(path.join(path.abspath(path.dirname(__file__)), 'VERSION'), encoding='utf-8') as f:
+    version = f.read()
+
+with open(path.join(path.abspath(path.dirname(__file__)), 'README'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(name='vuer',
+      packages=find_packages(),
+      install_requires=[
+          "killport",
+          "msgpack",
+          "params-proto",
+          "numpy",
+          "websockets",
+          "aiohttp-cors",
+          "pillow",
+      ],
+      description=long_description.split('\n')[0],
+      long_description=long_description,
+      author='Ge Yang<ge.ike.yang@gmail.com>',
+      url='https://github.com/vuer-ai/vuer',
+      author_email='ge.ike.yang@gmail.com',
+      package_data={'vuer': ['vuer', 'vuer/*.*']},
+      version=version)

vuer-0.0.50/vuer/__init__.py

@@ -0,0 +1,15 @@
+# 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.
+    
+    Also, we require numpy>=1.21 for numpy.typing.NDArray.
+    """)