python-best-practice

README.md

1. Install the following:
   1. VSCode
   2. Python extension
   3. Pylance extension
   4. Ruff extension
2. Open command palette in VSCode with Cmd + Shift + P
3. Type and select Preferences: Open Workspace Settings (JSON)
4. Copy and paste the following settings into your workspace settings file:

   {
       "notebook.formatOnSave.enabled": true,
       "python.analysis.typeCheckingMode": "strict",
       "python.analysis.inlayHints.functionReturnTypes": true,
       "python.analysis.inlayHints.variableTypes": true,
       "python.analysis.autoImportCompletions": true,
       "[python]": {
           "editor.formatOnSave": true,
           "editor.defaultFormatter": "charliermarsh.ruff",
           "editor.codeActionsOnSave": {
               "source.fixAll": "always",
               "source.organizeImports": "always"
           }
       }
   }

5. Save the settings to apply them. This will save a file in the file .vscode/settings.json.
6. Make sure .vscode/settings.json file is tracked in git by running git add .vscode/settings.json.

Now, your VSCode is all set up for an optimized Python development experience!