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 27, 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 27, 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.5.tar.gz (78.3 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.5-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trame_pyvista-0.1.5.tar.gz
Algorithm Hash digest
SHA256 dcab17fbef680d45a68e1922583d2d439c97f1092f1e55701ad48e7b52421af9
MD5 a548486ec610cf326ee20fc17d1352a5
BLAKE2b-256 31b191b1073a37456cd31ea79a2969b748dff73977c3217d620569de3cce62bd

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for trame_pyvista-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c33dd14f35002bd35138cc9377b589a4da3fbbb70fb298cb65187a5b3a0936f8
MD5 b3e819fea40a4eef90b1632b1bfc8213
BLAKE2b-256 662d2046636048895872f7434276d7bd632f7c3ab44315cd4222786779419f40

See more details on using hashes here.

Provenance

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