anythreejs 0.0.1__tar.gz

anythreejs-0.0.1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Mridul Seth.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the vector package developers nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

anythreejs-0.0.1/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: anythreejs
+Version: 0.0.1
+Summary: Anywidget wrapper for three.js
+Keywords: jupyter,widgets,threejs,3d,visualization,anywidget
+Author: Mridul Seth
+Author-email: Mridul Seth <mail@mriduls.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: anywidget>=0.9.21
+Requires-Dist: numpy>=2
+Requires-Dist: traitlets>=5.14.3
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/MridulS/anythreejs
+Project-URL: Repository, https://github.com/MridulS/anythreejs
+Description-Content-Type: text/markdown
+
+# anythreejs
+
+A Python / Three.js bridge for Jupyter notebooks, built on [anywidget](https://anywidget.dev/).
+
+This comes out of the need to have a lightweight wrapper around Three.js which is easy to maintain and extend, while being compatible with existing codebases using [pythreejs](https://github.com/jupyter-widgets/pythreejs).
+
+## Installation
+
+```bash
+pip install anythreejs
+```
+
+## Quick Start
+
+```python
+from anythreejs import (
+    Renderer,
+    Scene,
+    PerspectiveCamera,
+    OrbitControls,
+    Mesh,
+    BoxGeometry,
+    MeshStandardMaterial,
+    AmbientLight,
+    DirectionalLight,
+)
+
+# Create a scene
+scene = Scene(
+    children=[
+        Mesh(
+            geometry=BoxGeometry(1, 1, 1),
+            material=MeshStandardMaterial(color="#ff0c0cff", roughness=0.4),
+        ),
+        AmbientLight(intensity=0.4),
+        DirectionalLight(position=[5, 5, 5], intensity=1),
+    ],
+    background="#e5e5faff",
+)
+
+camera = PerspectiveCamera(position=[3, 3, 3])
+controls = OrbitControls(controlling=camera)
+
+# Display the widget (renderer is the widget)
+renderer = Renderer(
+    camera=camera,
+    scene=scene,
+    controls=[controls],
+    width=700,
+    height=450,
+)
+renderer
+```
+
+## API Overview
+
+anythreejs provides a subset of Three.js objects as Python classes. Currently we only cover the parts used by [plopp](https://github.com/scipp/plopp/). We should ideally automatically generate these classes from the Three.js documentation in the future.
+
+## Renderer Options
+
+```python
+Renderer(
+    scene=scene,           # Scene object
+    camera=camera,         # Camera object
+    controls=[controls],   # Controls list (e.g., OrbitControls)
+    width=800,             # Canvas width in pixels
+    height=600,            # Canvas height in pixels
+    antialias=True,        # Enable antialiasing
+    alpha=False,           # Canvas transparency
+)
+```
+
+## Interaction
+
+### Click Events
+
+```python
+import anythreejs as p3
+
+renderer = p3.Renderer(camera=camera, scene=scene, controls=[controls])
+
+def handle_click(change):
+    info = change.get("new", {})
+    if info:
+        print(f"Clicked: {info.get('name')} at {info.get('point')}")
+
+renderer.observe(handle_click, names=["_click_info"])
+renderer
+```
+
+## pythreejs Compatibility
+
+anythreejs tries to be API-compatible with the original `pythreejs`. For projects that already use pythreejs
+(like [plopp](https://github.com/scipp/plopp)), you can switch with minimal changes:
+
+```python
+# Instead of:
+# import pythreejs as p3
+
+# Use:
+import anythreejs as p3
+```
+
+### Example (pythreejs-style usage)
+
+```python
+import anythreejs as p3
+
+# Create camera
+camera = p3.PerspectiveCamera(aspect=800/600)
+camera.position = [5, 5, 5]
+
+# Create scene
+axes = p3.AxesHelper()
+scene = p3.Scene(children=[camera, axes], background="#f0f0f0")
+
+# Create controls
+controls = p3.OrbitControls(controlling=camera)
+
+# Create renderer (this is the widget)
+renderer = p3.Renderer(
+    camera=camera,
+    scene=scene,
+    controls=[controls],
+    width=800,
+    height=600,
+)
+
+# Add objects dynamically
+mesh = p3.Mesh(
+    geometry=p3.BoxGeometry(1, 1, 1),
+    material=p3.MeshStandardMaterial(color="#ff0000"),
+)
+scene.add(mesh)
+
+# Display
+renderer
+```
+
+## Credits
+
+- Inspired by the original [pythreejs](https://github.com/jupyter-widgets/pythreejs)
+- Built with [anywidget](https://anywidget.dev/)
+- Powered by [Three.js](https://threejs.org/)

anythreejs-0.0.1/README.md

@@ -0,0 +1,144 @@
+# anythreejs
+
+A Python / Three.js bridge for Jupyter notebooks, built on [anywidget](https://anywidget.dev/).
+
+This comes out of the need to have a lightweight wrapper around Three.js which is easy to maintain and extend, while being compatible with existing codebases using [pythreejs](https://github.com/jupyter-widgets/pythreejs).
+
+## Installation
+
+```bash
+pip install anythreejs
+```
+
+## Quick Start
+
+```python
+from anythreejs import (
+    Renderer,
+    Scene,
+    PerspectiveCamera,
+    OrbitControls,
+    Mesh,
+    BoxGeometry,
+    MeshStandardMaterial,
+    AmbientLight,
+    DirectionalLight,
+)
+
+# Create a scene
+scene = Scene(
+    children=[
+        Mesh(
+            geometry=BoxGeometry(1, 1, 1),
+            material=MeshStandardMaterial(color="#ff0c0cff", roughness=0.4),
+        ),
+        AmbientLight(intensity=0.4),
+        DirectionalLight(position=[5, 5, 5], intensity=1),
+    ],
+    background="#e5e5faff",
+)
+
+camera = PerspectiveCamera(position=[3, 3, 3])
+controls = OrbitControls(controlling=camera)
+
+# Display the widget (renderer is the widget)
+renderer = Renderer(
+    camera=camera,
+    scene=scene,
+    controls=[controls],
+    width=700,
+    height=450,
+)
+renderer
+```
+
+## API Overview
+
+anythreejs provides a subset of Three.js objects as Python classes. Currently we only cover the parts used by [plopp](https://github.com/scipp/plopp/). We should ideally automatically generate these classes from the Three.js documentation in the future.
+
+## Renderer Options
+
+```python
+Renderer(
+    scene=scene,           # Scene object
+    camera=camera,         # Camera object
+    controls=[controls],   # Controls list (e.g., OrbitControls)
+    width=800,             # Canvas width in pixels
+    height=600,            # Canvas height in pixels
+    antialias=True,        # Enable antialiasing
+    alpha=False,           # Canvas transparency
+)
+```
+
+## Interaction
+
+### Click Events
+
+```python
+import anythreejs as p3
+
+renderer = p3.Renderer(camera=camera, scene=scene, controls=[controls])
+
+def handle_click(change):
+    info = change.get("new", {})
+    if info:
+        print(f"Clicked: {info.get('name')} at {info.get('point')}")
+
+renderer.observe(handle_click, names=["_click_info"])
+renderer
+```
+
+## pythreejs Compatibility
+
+anythreejs tries to be API-compatible with the original `pythreejs`. For projects that already use pythreejs
+(like [plopp](https://github.com/scipp/plopp)), you can switch with minimal changes:
+
+```python
+# Instead of:
+# import pythreejs as p3
+
+# Use:
+import anythreejs as p3
+```
+
+### Example (pythreejs-style usage)
+
+```python
+import anythreejs as p3
+
+# Create camera
+camera = p3.PerspectiveCamera(aspect=800/600)
+camera.position = [5, 5, 5]
+
+# Create scene
+axes = p3.AxesHelper()
+scene = p3.Scene(children=[camera, axes], background="#f0f0f0")
+
+# Create controls
+controls = p3.OrbitControls(controlling=camera)
+
+# Create renderer (this is the widget)
+renderer = p3.Renderer(
+    camera=camera,
+    scene=scene,
+    controls=[controls],
+    width=800,
+    height=600,
+)
+
+# Add objects dynamically
+mesh = p3.Mesh(
+    geometry=p3.BoxGeometry(1, 1, 1),
+    material=p3.MeshStandardMaterial(color="#ff0000"),
+)
+scene.add(mesh)
+
+# Display
+renderer
+```
+
+## Credits
+
+- Inspired by the original [pythreejs](https://github.com/jupyter-widgets/pythreejs)
+- Built with [anywidget](https://anywidget.dev/)
+- Powered by [Three.js](https://threejs.org/)

anythreejs-0.0.1/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "anythreejs"
+version = "0.0.1"
+description = "Anywidget wrapper for three.js"
+readme = "README.md"
+authors = [
+    { name = "Mridul Seth", email = "mail@mriduls.com" }
+]
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = [
+    "anywidget>=0.9.21",
+    "numpy>=2",
+    "traitlets>=5.14.3",
+]
+keywords = ["jupyter", "widgets", "threejs", "3d", "visualization", "anywidget"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Jupyter",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+[project.urls]
+Homepage = "https://github.com/MridulS/anythreejs"
+Repository = "https://github.com/MridulS/anythreejs"
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "jupyterlab>=4.5.0",
+    "prek>=0.2.21",
+    "ruff>=0.14.9",
+]

anythreejs-0.0.1/src/anythreejs/__init__.py

@@ -0,0 +1,153 @@
+"""
+anythreejs - A modern Python/Three.js bridge for Jupyter
+
+Quick start:
+    from anythreejs import Renderer, Scene, PerspectiveCamera, OrbitControls
+    from anythreejs import Mesh, BoxGeometry, MeshStandardMaterial, AmbientLight
+
+    scene = Scene(background="#1a1a2e")
+    scene.add(Mesh(BoxGeometry(1, 1, 1), MeshStandardMaterial(color="#ff6600")))
+    scene.add(AmbientLight(intensity=0.5))
+
+    camera = PerspectiveCamera(position=(0, 0, 5))
+    controls = OrbitControls(controlling=camera)
+
+    renderer = Renderer(camera=camera, scene=scene, controls=[controls])
+    renderer  # Display in notebook
+
+For pythreejs-style namespace imports:
+    import anythreejs as p3
+    # Then use p3.Scene, p3.Renderer, etc.
+"""
+
+from .renderer import Renderer
+from .core import (
+    # Base
+    ThreeJSBase,
+    Object3D,
+    # Scene
+    Scene,
+    # Cameras
+    PerspectiveCamera,
+    OrthographicCamera,
+    # Controls
+    OrbitControls,
+    TrackballControls,
+    # Geometry
+    BufferGeometry,
+    BoxGeometry,
+    BoxBufferGeometry,
+    SphereGeometry,
+    SphereBufferGeometry,
+    PlaneGeometry,
+    PlaneBufferGeometry,
+    CylinderGeometry,
+    CylinderBufferGeometry,
+    TorusGeometry,
+    EdgesGeometry,
+    # Material
+    Material,
+    MeshBasicMaterial,
+    MeshStandardMaterial,
+    MeshPhongMaterial,
+    MeshLambertMaterial,
+    PointsMaterial,
+    LineBasicMaterial,
+    LineDashedMaterial,
+    SpriteMaterial,
+    # Objects
+    Mesh,
+    Points,
+    Line,
+    LineSegments,
+    Group,
+    Sprite,
+    # Lights
+    AmbientLight,
+    DirectionalLight,
+    PointLight,
+    HemisphereLight,
+    SpotLight,
+    # Helpers
+    AxesHelper,
+    GridHelper,
+    # Buffer
+    BufferAttribute,
+    Float32BufferAttribute,
+    Uint32BufferAttribute,
+    Uint16BufferAttribute,
+    Int32BufferAttribute,
+    # Textures
+    TextTexture,
+)
+
+# Convenience alias for pythreejs-style imports: `import anythreejs as p3`
+import sys as _sys
+
+p3 = _sys.modules[__name__]
+
+__version__ = "0.0.1"
+
+__all__ = [
+    # Renderer
+    "Renderer",
+    # Base
+    "ThreeJSBase",
+    "Object3D",
+    # Scene
+    "Scene",
+    # Cameras
+    "PerspectiveCamera",
+    "OrthographicCamera",
+    # Controls
+    "OrbitControls",
+    "TrackballControls",
+    # Geometry
+    "BufferGeometry",
+    "BoxGeometry",
+    "BoxBufferGeometry",
+    "SphereGeometry",
+    "SphereBufferGeometry",
+    "PlaneGeometry",
+    "PlaneBufferGeometry",
+    "CylinderGeometry",
+    "CylinderBufferGeometry",
+    "TorusGeometry",
+    "EdgesGeometry",
+    # Material
+    "Material",
+    "MeshBasicMaterial",
+    "MeshStandardMaterial",
+    "MeshPhongMaterial",
+    "MeshLambertMaterial",
+    "PointsMaterial",
+    "LineBasicMaterial",
+    "LineDashedMaterial",
+    "SpriteMaterial",
+    # Objects
+    "Mesh",
+    "Points",
+    "Line",
+    "LineSegments",
+    "Group",
+    "Sprite",
+    # Lights
+    "AmbientLight",
+    "DirectionalLight",
+    "PointLight",
+    "HemisphereLight",
+    "SpotLight",
+    # Helpers
+    "AxesHelper",
+    "GridHelper",
+    # Buffer
+    "BufferAttribute",
+    "Float32BufferAttribute",
+    "Uint32BufferAttribute",
+    "Uint16BufferAttribute",
+    "Int32BufferAttribute",
+    # Textures
+    "TextTexture",
+    # Convenience alias
+    "p3",
+]

anythreejs-0.0.1/src/anythreejs/core/__init__.py

@@ -0,0 +1,109 @@
+"""
+Core Three.js components.
+"""
+
+from .base import ThreeJSBase, Object3D
+from .scene import Scene
+from .camera import PerspectiveCamera, OrthographicCamera
+from .controls import OrbitControls, TrackballControls
+from .geometry import (
+    BufferGeometry,
+    BoxGeometry,
+    BoxBufferGeometry,
+    SphereGeometry,
+    SphereBufferGeometry,
+    PlaneGeometry,
+    PlaneBufferGeometry,
+    CylinderGeometry,
+    CylinderBufferGeometry,
+    TorusGeometry,
+    EdgesGeometry,
+)
+from .material import (
+    Material,
+    MeshBasicMaterial,
+    MeshStandardMaterial,
+    MeshPhongMaterial,
+    MeshLambertMaterial,
+    PointsMaterial,
+    LineBasicMaterial,
+    LineDashedMaterial,
+    SpriteMaterial,
+)
+from .objects import Mesh, Points, Line, LineSegments, Group, Sprite
+from .lights import (
+    AmbientLight,
+    DirectionalLight,
+    PointLight,
+    HemisphereLight,
+    SpotLight,
+)
+from .helpers import AxesHelper, GridHelper
+from .buffer import (
+    BufferAttribute,
+    Float32BufferAttribute,
+    Uint32BufferAttribute,
+    Uint16BufferAttribute,
+    Int32BufferAttribute,
+)
+from .textures import TextTexture
+
+__all__ = [
+    # Base
+    "ThreeJSBase",
+    "Object3D",
+    # Scene
+    "Scene",
+    # Cameras
+    "PerspectiveCamera",
+    "OrthographicCamera",
+    # Controls
+    "OrbitControls",
+    "TrackballControls",
+    # Geometry
+    "BufferGeometry",
+    "BoxGeometry",
+    "BoxBufferGeometry",
+    "SphereGeometry",
+    "SphereBufferGeometry",
+    "PlaneGeometry",
+    "PlaneBufferGeometry",
+    "CylinderGeometry",
+    "CylinderBufferGeometry",
+    "TorusGeometry",
+    "EdgesGeometry",
+    # Material
+    "Material",
+    "MeshBasicMaterial",
+    "MeshStandardMaterial",
+    "MeshPhongMaterial",
+    "MeshLambertMaterial",
+    "PointsMaterial",
+    "LineBasicMaterial",
+    "LineDashedMaterial",
+    "SpriteMaterial",
+    # Objects
+    "Mesh",
+    "Points",
+    "Line",
+    "LineSegments",
+    "Group",
+    "Sprite",
+    # Lights
+    "AmbientLight",
+    "DirectionalLight",
+    "PointLight",
+    "HemisphereLight",
+    "SpotLight",
+    # Helpers
+    "AxesHelper",
+    "GridHelper",
+    # Buffer
+    "BufferAttribute",
+    "Float32BufferAttribute",
+    "Uint32BufferAttribute",
+    "Uint16BufferAttribute",
+    "Int32BufferAttribute",
+    # Textures
+    "TextTexture",
+]