Install & Compatibility
Where this runs
tested against v3.13.2 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
installs and imports cleanly · install 0.0s · import 0.729s · 33.8MB
glibcpy 3.10–3.920 runs
installs and imports cleanly · install 4.7s · import 0.657s · 37MB
34MB installed
● package 34MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
get_server
✓ from trame.app import get_server
SinglePageLayout
✓ from trame.ui.vuetify3 import SinglePageLayout
✗ from trame.ui.vuetify import SinglePageLayout
For Trame v3+, the default client is Vue3, so import from `vuetify3`. Older Vue2-based layouts or widgets will cause issues.
v3
✓ from trame.widgets import vuetify3 as v3
✗ from trame.widgets import vuetify as v2
Trame v3 defaults to Vue3 widgets. Use `vuetify3` for new projects. Older `vuetify` (Vue2) widgets may still be used if `server.client_type` is explicitly set to 'vue2'.
This quickstart code initializes a Trame server, sets a reactive state variable, and defines a simple single-page layout using Vuetify3 widgets. It creates a card with a title that updates when a button is clicked, demonstrating basic interactivity. The application runs locally and opens in a web browser upon execution.
from trame.app import get_server
from trame.ui.vuetify3 import SinglePageLayout
from trame.widgets import vuetify3 as v3
server = get_server(client_type="vue3") # Explicitly set for clarity in v3+ apps
server.state.name = "Trame"
with SinglePageLayout(server) as layout:
layout.title.set_text("Hello Trame")
with layout.content:
with v3.VContainer(classes="fill-height", fluid=True):
with v3.VRow(classes="fill-height", align="center", justify="center"):
with v3.VCol(cols=12, sm=6, md=4):
v3.VCard(
v3.VCardTitle(classes="headline", children=["Welcome to ", ('name', 'Trame App')]),
v3.VCardText("This is a simple Trame application running in Vue3!"),
v3.VCardActions(
v3.VSpacer(),
v3.VBtn('Click me!', click='server.state.name = "Updated Trame"'),
v3.VSpacer(),
)
)
if __name__ == '__main__':
server.start()
trame --version
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'trame'
The 'trame' library has not been installed in your Python environment, or the environment where you are running the script is not the one where Trame was installed.
ModuleNotFoundError: No module named 'trame.widgets.vuetify'
The specific Trame widget package (e.g., 'trame-vuetify') has not been installed; the base 'trame' package does not include all widget sets, which are distributed as separate packages.
fixpip install trame-vuetify
AttributeError: 'App' object has no attribute 'start'
The 'start()' method to run the Trame server is invoked on the 'App' instance directly, rather than on the 'Server' object obtained from 'get_server()'.
fixfrom trame.app import get_server
server = get_server()
server.start()
RuntimeError: Server could not be started
The specified port for the Trame server is already in use by another application or process, or there's a network configuration issue preventing the server from binding to the port.
fixTry running the Trame application on a different port using 'server.start(port=8081)' or by setting the TRAME_APP_PORT environment variable before starting the application.
Upgrade
Version history
3.13.2latest on PyPI · released May 15, 2026
Audit
Dependencies
trame-vuetifyoptionalProvides Vuetify UI components for building rich user interfaces.
trame-vtkoptionalEnables 3D visualization capabilities using VTK (Visualization Toolkit).
pywebviewoptionalRequired for packaging Trame applications as desktop apps with the '--app' flag.
jupyterlaboptionalNeeded to run Trame applications directly within JupyterLab environments.
notebookoptionalNeeded to run Trame applications directly within classic Jupyter Notebook environments.
requestsoptionalRequired when Trame applications need to interact with remote assets, such as GDrive files.