📝 Maintenance: cleanup readme and vscode settings (ITISFoundation#5023)

.vscode/extensions.json

@@ -3,9 +3,13 @@
     "charliermarsh.ruff",
     "eamodio.gitlens",
     "exiasr.hadolint",
+    "ms-azuretools.vscode-docker",
+    "ms-python.black-formatter",
+    "ms-python.pylint",
     "ms-python.python",
     "njpwerner.autodocstring",
     "samuelcolvin.jinjahtml",
     "timonwong.shellcheck",
+    "vscode-icons-team.vscode-icons",
   ]
 }

.vscode/settings.template.json

@@ -1,5 +1,7 @@
 // This is a template. Clone and replace extension ".template.json" by ".json"
 {
+  "autoDocstring.docstringFormat": "pep257",
+
   "editor.tabSize": 2,
   "editor.insertSpaces": true,
   "editor.detectIndentation": false,
@@ -27,9 +29,8 @@
     "**/.git/subtree-cache/**": true,
     "**/node_modules/*/**": true
   },
-  "python.formatting.autopep8Args": [
-    "--max-line-length 140"
-  ],
+  "python.analysis.autoImportCompletions": true,
+  "python.analysis.typeCheckingMode": "basic",
   "python.analysis.extraPaths": [
     "./packages/models-library/src",
     "./packages/postgres-database/src",
@@ -54,26 +55,15 @@
   "[makefile]": {
     "editor.insertSpaces": false
   },
-  "python.testing.pytestEnabled": true,
-  "autoDocstring.docstringFormat": "pep257",
   "hadolint.hadolintPath": "${workspaceFolder}/scripts/hadolint.bash",
   "hadolint.cliOptions": [],
-  "shellcheck.executablePath": "${workspaceFolder}/scripts/shellcheck.bash",
-  "shellcheck.run": "onSave",
-  "shellcheck.enableQuickFix": true,
-  "python.formatting.provider": "black",
-  "isort.path": [
-    "${workspaceFolder}/.venv/bin/isort"
-  ],
-  "isort.args": [
-    "--settings-path=${workspaceFolder}/.isort.cfg"
-  ],
-  "python.analysis.autoImportCompletions": true,
-  "python.analysis.typeCheckingMode": "basic",
   "ruff.lint.args": [
     "--config=${workspaceFolder}/.ruff.toml"
   ],
   "ruff.path": [
     "${workspaceFolder}/.venv/bin/ruff"
-  ]
+  ],
+  "shellcheck.executablePath": "${workspaceFolder}/scripts/shellcheck.bash",
+  "shellcheck.run": "onSave",
+  "shellcheck.enableQuickFix": true
 }

README.md

@@ -4,7 +4,6 @@
 <img src="https://user-images.githubusercontent.com/32800795/61083844-ff48fb00-a42c-11e9-8e63-fa2d709c8baf.png" width="500">
 </p>
 
-
 <!-- BADGES: LINKS ON CLICK --------------------------------------------------------------->
 [![black_badge]](https://github.com/psf/black)
 [![ci_badge]](https://github.com/ITISFoundation/osparc-simcore/actions/workflows/ci-testing-deploy.yml)
@@ -28,7 +27,6 @@
 [osparc_status]:https://img.shields.io/badge/dynamic/json?label=osparc.io&query=%24.status.description&url=https%3A%2F%2Fstatus.osparc.io%2Fapi%2Fv2%2Fstatus.json
 <!------------------------------------------------------------------------------------------>
 
-
 The SIM-CORE, named **o<sup>2</sup>S<sup>2</sup>PARC** – **O**pen **O**nline **S**imulations for **S**timulating **P**eripheral **A**ctivity to **R**elieve **C**onditions – is one of the three integrative cores of the SPARC program’s Data Resource Center (DRC).
 The aim of o<sup>2</sup>S<sup>2</sup>PARC is to establish a comprehensive, freely accessible, intuitive, and interactive online platform for simulating peripheral nerve system neuromodulation/ stimulation and its impact on organ physiology in a precise and predictive manner.
 To achieve this, the platform will comprise both state-of-the art and highly detailed animal and human anatomical models with realistic tissue property distributions that make it possible to perform simulations ranging from the molecular scale up to the complexity of the human body.
@@ -72,15 +70,14 @@ Services are deployed in two stacks:``simcore-stack`` comprises all core-service
 To build and run:
 
 - git
-- docker
+- [docker](https://docs.docker.com/engine/install/ubuntu/#installation-methods)
 - make >=4.2
 - awk, jq (optional tools within makefiles)
 
 To develop, in addition:
 
-- python 3.10
-- nodejs for client part (this dependency will be deprecated soon)
-- swagger-cli (make sure to have a recent version of nodejs)
+- *python 3.10*: we recommend using the python manager [pyenv](https://brain2life.hashnode.dev/how-to-install-pyenv-python-version-manager-on-ubuntu-2004)
+- *nodejs* for client part: we recommend using the node manager [nvm](https://github.com/nvm-sh/nvm#install--update-script)
 - [vscode] (highly recommended)
 
 To verify current base OS, Docker and Python build versions have a look at:
@@ -135,7 +132,7 @@ To upgrade a single requirement named `fastapi`run:
 
 - [Git release workflow](docs/releasing-workflow-instructions.md)
 - Public [releases](https://github.com/ITISFoundation/osparc-simcore/releases)
-- Production in https://osparc.io
+- Production in <https://osparc.io>
 - [Staging instructions](docs/releasing-workflow-instructions.md#staging-example)
 - [User Manual](https://itisfoundation.github.io/osparc-manual/)
 
@@ -191,6 +188,5 @@ This project is licensed under the terms of the [MIT license](LICENSE).
 </p>
 
 <!-- ADD REFERENCES BELOW AND KEEP THEM IN ALPHABETICAL ORDER -->
-[chocolatey]:https://chocolatey.org/
 [vscode]:https://code.visualstudio.com/
 [WSL2]:https://docs.microsoft.com/en-us/windows/wsl