This PR adds the iCatcher+ results visualization UI to the codebase. This comprises five main changes:
Addition of web app code to the src/icatcher/icatcher_app directory. This directory contains two folders, one housing all of the React frontend code, and the other containing a basic flask API.
Changes to cli.py and options.py, plus the addition of ui_packaging.py, that together allow users to (1) launch the app using the icatcher CLI and (2) add a flag to create the necessary UI output when processing a video
Addition of 'flask' and 'flask_cors' dependencies to the pyproject.toml; used for running the app API
A MANIFEST.in that includes the built React app code in the python project when installed via pip
Additions to the test.yml and publish.yml github workflows that add steps to build the React app and, for the latter, make the resulting build directory available to be included in the pip package.
Additions to the main README to document how to run the app, plus the addition of a README in src/icatcher/icatcher_app that provides further developer-oriented documentation
This PR adds the iCatcher+ results visualization UI to the codebase. This comprises five main changes:
src/icatcher/icatcher_app
directory. This directory contains two folders, one housing all of the React frontend code, and the other containing a basic flask API.cli.py
andoptions.py
, plus the addition ofui_packaging.py
, that together allow users to (1) launch the app using the icatcher CLI and (2) add a flag to create the necessary UI output when processing a videotest.yml
andpublish.yml
github workflows that add steps to build the React app and, for the latter, make the resulting build directory available to be included in the pip package.src/icatcher/icatcher_app
that provides further developer-oriented documentation