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 Aug 14, 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:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: The PyVista Developers

GitHub Statistics

Data verified by PyPI on Aug 14, 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.7.tar.gz (79.6 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.7-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame_pyvista-0.1.7.tar.gz
  • Upload date:
  • Size: 79.6 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.7.tar.gz
Algorithm Hash digest
SHA256 13d2c5d6fb58562891372a3638f40ea88f39d4e4414de927ee797e7907244233
MD5 615f051afd221240101d9725f6fd72af
BLAKE2b-256 b8750cab7683efdc93d1e0d652727a6c847af9169276a8c77317819ea786096b

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_pyvista-0.1.7.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.7-py3-none-any.whl.

File metadata

  • Download URL: trame_pyvista-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 29.1 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c728d85732bc6e0eb69cef11205e55c9b921e8e587d9590d86dc29a65ad65202
MD5 c460e7fcb05718df555c33b6ebd200a6
BLAKE2b-256 f17e14338648aaca4598437f62438b802727af9781824d120c47ca70d6cae96b

See more details on using hashes here.

Provenance

The following attestation bundles were made for trame_pyvista-0.1.7-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