movie-narrator-web

Web UI (FastAPI + React) for movie-narrator.

Versioning: This package uses an independent version line, separate from the core engine (movie-narrator). Compatibility is guaranteed by the CONTRACT_VERSION check at import time — you do not need to match version numbers between the two packages.

This is a separate package from the core engine. Install it only if you need the web interface:

pip install movie-narrator-web

This automatically pulls in movie-narrator (core engine) and all web dependencies (FastAPI, uvicorn).

Prerequisites

• Python >= 3.10
• ffmpeg (required by the core engine for audio/video processing)

Usage

mn-web --host 127.0.0.1 --port 8760

For development with auto-reload:

mn-web --reload

CLI Options

Or programmatically:

from movie_narrator_web import launch_web_api

launch_web_api(host="127.0.0.1", port=8760)

Development

The frontend source is in webui/ (React + Vite + TypeScript + shadcn/ui). Build the SPA before packaging:

cd webui
npm ci
npm run build

The build output lands in src/movie_narrator_web/static/ and is served by FastAPI in production mode.

Internationalization

The Web UI is bilingual (Chinese / English). A language switcher in the header lets you toggle between the two; the default follows your browser language and your choice is remembered in localStorage. The selected language is also sent to the backend as a lang (zh | en) form field and passed downstream to the pipeline, so narration can be generated in the active language.

Architecture

This package depends on movie-narrator exclusively through the public contract layer (movie_narrator.contract). No internal module imports.

Documentation

• Changelog
• Contributing

License

Licensed under the AGPL-3.0-or-later License.