Merge pull request #13 from domschl/install_fix

Fix python module versions via preferences.txt and venv

Author: domschl

.gitignore

@@ -11,4 +11,10 @@ mchess/web/node_modules
 mchess/mchess.log
 mchess/web/package-lock.json
 mchess/turquoise.log
+mchess/bin
+mchess/lib64
+mchess/lib
+mchess/include
+mchess/pyvenv.cfg
 .DS_Store
+

README.md

@@ -20,34 +20,60 @@ Currently, the following platforms are under development:
 | USB          | x     | x            | x     | x       |
 | Bluetooth LE | x     | x            |       |
 
-## Alpha installation instructions
+## Installation instructions
 
-This project is under heavy development, and basically everything described below might change at some point.
+The project requires Python 3.7 and later (tested with 3.11). Please use a Python virtual environment to install the dependencies:
 
-### Dependencies
-
-`python-mchess` is written for Python >= 3.7.
-If UCI-engine support (python-chess dependency) is not used, any Python 3.x works. (python-mchess makes use of latest async features of Python 3.7 and later)
+```bash
+git clone https://github.com/domschl/python-mchess
+cd python-mchess
+# In folder python-mchess:
+python -m venv mchess
+cd mchess
+# Windows: Scripts\activate.bat
+source bin/activate
+# Now install dependencies:
+python -m pip install -r requirements.txt
+# On Linux, install bluepy, skip for macOS and Windows:
+python -m pip install bluepy
+```
 
-`python-mchess` board driver for Chess Link depends on `PySerial` and (Linux/Raspberry Pi only) `BluePy`
+### Notes on venv usage
 
-#### Optional UCI engine support
+When stopping to use the virtual environment, use `deactivate` to deactivate the virtual environment, each time you come back to the project, use `source bin/activate` to activate the virtual environment.
 
-In order to use UCI engines with mchess, additionally `python-chess` is used, the Tkinter-GUI prototype uses `Pillow`.
+To check, if you are running a `venv` environment:
 
 ```bash
-pip3 install pyserial [bluepy] [python-chess] [Pillow]
+pip -V
+# should show something like:
+# <some-path>//python-mchess/mchess/lib/python3.11/site-packages/pip (python 3.11)
+# path should contain 'python-mchess/mchess'
 ```
 
-Then clone the repository
+```bash
+- On Windows, use `Scripts\activate.bat` instead of `bin/activate` to activate the environment. On Linxu/macOS use `source bin/activate`.
+- On Windows, the `Scripts` folder is hidden by default. Use `dir /a` to list all files and folders.
+- To deactivate the virtual environment, use `deactivate` on Linux/macOS, or `Scripts\deactivate.bat` on Windows.
+
+#### Web client
+
+Node JS packet manager `npm` is needed to install the javascript dependencies:
 
 ```bash
-git clone https://github.com/domschl/python-mchess
+# In folder python-mchess:
+cd mchess/web
+npm install
 ```
 
+This installs the dependencies `cm-chessboard` and `charts.js`.
+
+## Configuration
+
 Now configure some engines:
 
 ```bash
+# In folder python-mchess:
 cd mchess/engines
 ```
 
@@ -66,23 +92,6 @@ A sample content for stockfish in Linux would be:
 
 Note: Windows users need to use paths with `\\` or `/` for proper json encoding.
 
-#### Web client
-
-The web agent requires python modules `Flask`, `Flask-Sockets` and `gevent`.
-
-```bash
-pip3 install flask flask-sockets gevent
-```
-
-Node JS packet manager `npm` is needed to install the javascript dependencies:
-
-```bash
-cd mchess/web
-npm install
-```
-
-This installs the dependencies `cm-chessboard` and `charts.js`.
-
 ### Start
 
 Then in directory `mchess`, simply start from console:

mchess/requirements.txt

@@ -0,0 +1,12 @@
+# https://docs.python.org/3/tutorial/venv.html
+
+pyserial
+chess
+pillow
+# bluepy
+
+markupsafe==2.0.1
+Flask==1.1.4 
+Flask-Sockets==0.2.1
+gevent # ==21.12.0
+gevent-websocket # ==0.10.1

mchess/web/package.json

@@ -1,7 +1,7 @@
 {
   "lockfileVersion": 1,
   "dependencies": {
-    "cm-chessboard": "^2.15.3",
-    "chart.js": "^2.9.3"
+    "chart.js": "^2.9.3",
+    "cm-chessboard": "^2.15.7"
   }
 }