trame-pyvista

Trame interface for PyVista. Provides web-based 3D viewers, Jupyter backends, scene exporters, and a Sphinx directive for embedding interactive plots in docs.

This package was extracted from the pyvista.trame subpackage so the trame stack can release on its own cadence. PyVista discovers installed functionality through entry points, so existing user code keeps working once trame-pyvista is installed.

Install

pip install trame-pyvista

For Jupyter:

pip install "trame-pyvista[jupyter]"

What you get

  • Jupyter backends: trame, server, client, html. Registered with PyVista via the pyvista.jupyter_backends entry-point group, so pv.set_jupyter_backend('trame') works once trame-pyvista is installed.

  • Plotter views: PyVistaLocalView, PyVistaRemoteView, PyVistaRemoteLocalView for embedding in trame apps.

  • plotter.trame namespace: registered as a PyVista plotter component so exporters live under the trame namespace:

    import pyvista as pv

pl = pv.Plotter()
pl.add_mesh(pv.Sphere())
pl.trame.export_vtksz('scene.vtksz')
pl.trame.export_html('scene.html')

  • Sphinx directive: trame_pyvista.sphinx_ext provides the offlineviewer directive used by PyVista docs to embed exported .vtksz scenes. Add to conf.py:

    extensions = ['trame_pyvista.sphinx_ext']

Usage

import pyvista as pv

pv.set_jupyter_backend('trame')
pl = pv.Plotter()
pl.add_mesh(pv.Wavelet())
pl.show()

Custom UI:

from trame_pyvista import plotter_ui

ui = plotter_ui(plotter, mode='trame')

See examples/ for runnable scripts covering local/remote views, custom UIs, and toolbar customization.

Development

Uses uv and just:

just sync         # create venv and install dev deps
just test         # unit tests
just test-playwright  # Sphinx + browser integration tests
just lint         # pre-commit (ruff, etc.)
just typecheck
just build

License

MIT. See LICENSE.

Project links

Data verified by PyPI on Jul 29, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.7)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: The PyVista Developers

GitHub Statistics

Data verified by PyPI on Jul 29, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Provides Extra

jupyter sphinx test playwright dev

Tags

vtk trame pyvista jupyter visualization

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trame_pyvista-0.1.6.tar.gz (79.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trame_pyvista-0.1.6-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file trame_pyvista-0.1.6.tar.gz.

File metadata

  • Download URL: trame_pyvista-0.1.6.tar.gz
  • Upload date:
  • Size: 79.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for trame_pyvista-0.1.6.tar.gz
Algorithm Hash digest
SHA256 4cac6c91244fed48be220191184566b5984230b41e088d1b101d6dcd9485f29e
MD5 208604d5e73c5e30ec7428d8f799371a
BLAKE2b-256 3cc18e9d6b2b4550b78eec939f0c7b1c3f2fe5f75fe5a2d4fc3ac67f2aab6170

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_pyvista-0.1.6.tar.gz:

Publisher: ci.yml on pyvista/trame-pyvista

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trame_pyvista-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: trame_pyvista-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for trame_pyvista-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 43471f6b7abc71a014dba38f516727394cf583207f7806fb7a8ab639448a0c47
MD5 b89e2048350c3c89dc1b329e58a8b5fd
BLAKE2b-256 09750fa49c218e2b3e23918e64d0add81614f31fd6acdfa647e980f9d2066a43

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_pyvista-0.1.6-py3-none-any.whl:

Publisher: ci.yml on pyvista/trame-pyvista

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page