Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Freeze version numbers in requirements.txt to prevent accidentally incompatible upgrades #24

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

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
Expand Down Expand Up @@ -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

Expand Down
18 changes: 9 additions & 9 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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