COMP587-Project-App

The front-end application of the software system under test for COMP 587 : Verification & Validation project.

download

You can download the app here or install from source following the instructions below.

dev environment setup

0. Install Python 3.10 if you haven't already.
1. Use git clone https://github.com/chizuo/COMP587-MovieApplication.git where you want the project's folder to appear and cd into the new folder.
2. Create a virtual environment, such as with py -3.10 -m venv venv or python3.10 -m venv venv.
3. Activate the virtual environment.
4. Use pip install -r requirements.txt to install the app's dependencies.
5. If you will edit the app, use pip install -r requirements-dev.txt to install the development dependencies.
6. If you will make commits, run pre-commit install to set up the git pre-commit hooks.
7. Choose whether USE_MOCK_DATA (in dev_settings.py) should be set to True or False.

After the environment is set up, you can use these commands (while in the project's root folder):

• briefcase dev to run the app in dev mode. See BeeWare Briefcase's docs for more info if needed.
• pytest to run the unit tests.
• pre-commit run --all-files to run all the pre-commit hooks without committing.
• pre-commit run hook-id-here --file file-path-here.py to run one pre-commit hook on one file without committing.

distribution

• briefcase dev to run the app in dev mode.
• briefcase create to create the app template.
• briefcase update to copy new changes into the platform directory.
• briefcase update -d to update the dependencies in the packaged app.
• briefcase build to compile the app.
• briefcase run to run the compiled app.
• briefcase run -u to update, build, and run the compiled app.
• briefcase package to create the app's installer for the current platform.
• briefcase package -u to update, build, and create the app's installer for the current platform.

dependency docs

• Python
• pytest
• pytest-qt
• PySide
• BeeWare Briefcase
• pre-commit
• Black
• mypy
• flake8