Skip to content

Development

Setup

git clone https://github.com/molcrafts/molvis
cd molvis
npm install

Build

There is no separate Python-side JS build anymore. The single frontend lives in page/ and is built once; the Python package ships the bundle as static assets.

npm run build:page          # page bundle → python/src/molvis/dist/
npm run build:all           # core + page + vsc-ext

Live reload during development

Two terminals:

npm run dev:page

MOLVIS_PAGE_DIST=page/dist python test_molvis.py

The MOLVIS_PAGE_DIST environment variable overrides the bundled static assets, pointing to the dev server's output for live reload.

Testing

npm test                         # all workspaces (core, page, vsc-ext, python)
npm run test:python              # pytest only
npm run test:core                # core rstest

Packaging

npm run build:page               # ships page bundle into python/src/molvis/dist/
cd python
python3 -m build --wheel

Project structure

python/
  src/molvis/
    __init__.py            # Public API: Molvis, WebSocketTransport, Selection, …
    scene.py               # Molvis class — transport-agnostic
    events.py              # EventBus, ViewerState, Selection
    transport_base.py      # Transport Protocol
    transport/
      __init__.py          # Package entry
      _codec.py            # BinaryPayloadEncoder/Decoder + binary frame codec
      websocket.py         # WebSocketTransport (server + handshake + dispatch)
    commands/              # Command mixins (drawing, selection, snapshot, frame, …)
    dist/             # Built page bundle (gitignored, populated by build:page)