pyvista / pyvistaqt-exe

Create a Windows installable exe from a PyVistaQt application

PyVistaQt Standalone Application

Create a standalone 3D viewer application with PyVistaQt.

This repository provides a template for creating a Windows executable (.exe) of a standalone PyVistaQt application.

Features

• Bundle assets into the executable
• Create custom menus and actions
• Automated building on CI

Locally Build

On any OS, you can create your own standalone application with:

pip install -r requirements.txt
pyinstaller main.spec

The executable will then be located in the dist/main directory. To distribute, you can zip this directory.

Automatized Build

The GitHub Actions workflow here will build the Windows installable executable and upload as an artifact to the workflow run.

This workflow also contains a Release step which will upload the executable in the release on tag. Generate a tag with:

git tag v0.1.0
git push --tags

License

This repository uses the MIT License. Contributions are welcome.

pyvistaqt-exe's Issues

Bundle the _internal directory

The current build ships an _internal directory along side the .exe with a lot of DLLs. Is this needed? Can we bundle this in the .exe to have a "single file executable"?

Release artifact upload

It's pretty awesome that we have CI set up to build the Windows .exe executable. We should extent this so that on tags, a release is created and the exe is uploaded as a release artifact.

Update the screenshot

Considering this template is focused on Windows executables, someone with Windows may want to change the screenshot I uploaded from my Mac.

The Mac screenshot might mislead users

Improve upstream UI helpers

pyvistaqt-exe/main.py

Line 11 in de2ffaf

from pyvistaqt.utils import _create_menu_bar

We're using some private methods here to help generate a common UI. It'd be good to make sure these are not private methods upstream.

cc @pyvista/pyvistaqt-admin