Add requirements update procedure

README.md

@@ -12,7 +12,7 @@ Alternatively the project can be build and run with the following commands:
     source env/bin/activate
     pip install --upgrade pip
 
-    pip install -r requirements.txt
+    pip install -r requirements-freeze.txt
     python optimizerapi/server.py
 
 Now open [http://localhost:9090/v1.0/ui/](http://localhost:9090/v1.0/ui/) in a browser to explore the API through Swagger UI
@@ -46,3 +46,20 @@ Running using python
 or use docker
 
     docker run -d --name process-optimizer-api --env PICKLE_KEY=<key from previous step> -p 9090:9090 process-optimizer-api:latest
+
+# Adding or updating dependencies
+
+When adding a new dependency, you should manually add it to `requirements.txt` and then run the following commands:
+
+    pip install -r requirements.tx
+    pip freeze > requirements-freeze.txt
+
+Now you should check if the freeze operation resulted in unwanted upates by running:
+
+    git diff requirements-freeze.txt
+
+After manually fixing any dependencies, you should run:
+
+    pip install -r requirements-freeze.txt
+
+Remember to commit both the changed `requirements.txt` and `requirements-freeze.txt` files.

requirements-freeze.txt

@@ -0,0 +1,53 @@
+attrs==20.3.0
+bokeh==2.2.3
+certifi==2020.12.5
+cffi==1.14.5
+chardet==4.0.0
+click==7.1.2
+clickclick==20.10.2
+colorama==0.4.4
+connexion==2.7.0
+cryptography==3.4.7
+cycler==0.10.0
+deap==1.3.1
+docopt==0.6.2
+Flask==1.1.2
+idna==2.10
+inflection==0.5.1
+iniconfig==1.1.1
+itsdangerous==1.1.0
+Jinja2==2.11.3
+joblib==1.0.1
+json-tricks==3.15.5
+jsonschema==3.2.0
+kiwisolver==1.3.1
+MarkupSafe==1.1.1
+matplotlib==3.3.4
+numpy==1.20.1
+openapi-spec-validator==0.2.9
+packaging==20.9
+Pillow==8.1.0
+pkg_resources==0.0.0
+pluggy==0.13.1
+ProcessOptimizer==0.6.4
+py==1.10.0
+pycparser==2.20
+pyparsing==2.4.7
+pyrsistent==0.17.3
+pytest==6.2.2
+pytest-watch==4.2.0
+python-dateutil==2.8.1
+PyYAML==5.4.1
+requests==2.25.1
+scikit-learn==0.24.2
+scipy==1.6.0
+six==1.15.0
+swagger-ui-bundle==0.0.8
+threadpoolctl==2.1.0
+toml==0.10.2
+tornado==6.1
+typing-extensions==3.7.4.3
+urllib3==1.26.3
+waitress==2.0.0
+watchdog==2.0.2
+Werkzeug==1.0.1