From 5a1f97ccfffb79405e1695bb87479b9337183c0a Mon Sep 17 00:00:00 2001 From: Zylos Date: Thu, 11 Apr 2024 18:45:53 -0400 Subject: [PATCH 1/2] Fix version numbers in requirements.txt to prevent accidentally incompatible upgrades --- README.md | 13 +++++++++++-- requirements.txt | 18 +++++++++--------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b1a2028..3401c3d 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,15 @@ Navigate to the cloned repository directory using the cd command: cd laser-level-webcam ``` +Ensure you are running Python 3.11 by checking your running python version: +```sh +python --version +``` + +It should respond with `Python 3.11.9` + +Python 3.12 cannot be used due to an incompatability with the currently used PySide6 version + Next, create a virtual environment for isolating the program's dependencies. Run the following commands: 2a. if you are missing virtualenv, install it with pip @@ -107,9 +116,9 @@ This command uses `pip` to install the packages specified in the requirements.tx After installing the required packages, you are ready to run the Python program: ```sh -python.exe laser_level_tool/main.py +python.exe .\laser-level-webcam.py ``` -We run the `main.py` file in the `laser_level_tool` directory +Running the `laser-level-webcam.py` file in the project root directory will boot up the PyQT application ## Usage diff --git a/requirements.txt b/requirements.txt index 73c3925..9fd3305 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,9 @@ -numpy>=1.21.6 -PySide6>=6.3.2 -PySide6-Addons>=6.5.1.1 -PySide6-Essentials>=6.5.1.1 -scipy>=1.7.3 -pyqtdarktheme>=2.1.0 -qimage2ndarray>=1.10.0 -matplotlib>=3.5.3 -plotly +numpy==1.26.4 +PySide6==6.5.1.1 +PySide6-Addons==6.5.1.1 +PySide6-Essentials==6.5.1.1 +scipy==1.13.0 +pyqtdarktheme==2.1.0 +qimage2ndarray==1.10.0 +matplotlib==3.8.4 +plotly==5.20.0 \ No newline at end of file From 5bd886bb9d0c3793f71d1fbe8d22b87e9df104d8 Mon Sep 17 00:00:00 2001 From: Zylos Date: Thu, 11 Apr 2024 19:22:07 -0400 Subject: [PATCH 2/2] Add new line and rework wording on version requirement --- README.md | 2 +- requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3401c3d..4dbe590 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Ensure you are running Python 3.11 by checking your running python version: python --version ``` -It should respond with `Python 3.11.9` +It should respond with a version containing `Python 3.11`. `Python 3.11.9` for instance would be acceptable. Python 3.12 cannot be used due to an incompatability with the currently used PySide6 version diff --git a/requirements.txt b/requirements.txt index 9fd3305..e812d73 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,4 +6,4 @@ scipy==1.13.0 pyqtdarktheme==2.1.0 qimage2ndarray==1.10.0 matplotlib==3.8.4 -plotly==5.20.0 \ No newline at end of file +plotly==5.20.0