Skip to main content

Getting Started With PyWee Apps

PyWee apps are local trusted GUI applications. The UI is regular HTML/CSS, and frontend behavior can be written in Python through <script type="python">.

Install PyWee​

Install the published runtime into your active Python environment from PyPI:

python3 -m pip install pywee

Check whether the managed Chromium runtime is present:

pywee chromium status

Download the locked Chromium runtime explicitly, or let pywee run download it on first use:

pywee chromium install
pywee chromium verify

PyWee does not search for a system Chromium.

Project Shape​

Most apps use this layout:

my-app/
  pywee.toml
  assets/
  web/
    index.html
    style.css
  python/
    main.py

Small examples can keep Python inline in index.html. Larger apps should move logic into python/main.py and regular Python modules.

Run An Example​

Clone the standalone examples repository once:

git clone https://gitlab.com/pywee/examples.git
cd examples
pywee run examples/hello-world
pywee run examples/controls
pywee run examples/3d-viewer

For headless verification:

pywee run examples/hello-world --no-window --dump-dom

Install App Dependencies​

App dependencies are declared in pywee.toml:

[python]
enabled = true
requirements = ["opencv-python"]

Install them into the Python environment that launches pywee:

pywee pip examples/camera-cv2 install-deps

requirements.txt is not used by PyWee examples.

Create A New App​

pywee init my-app
pywee run my-app

The generated app is intentionally small. Use the examples as copyable patterns for controls, charts, simple games, camera access, and Python-driven UI updates.