diff options
Diffstat (limited to 'extension/scripts/README.md')
| -rw-r--r-- | extension/scripts/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/extension/scripts/README.md b/extension/scripts/README.md new file mode 100644 index 00000000..0f851cb4 --- /dev/null +++ b/extension/scripts/README.md @@ -0,0 +1,5 @@ +# Scripts + +Whenever we need python to run on the client side, we include a script file at the top level of this folder. All other files that are not to be run directly as a script (utility files) should be in a subfolder of `scripts`. You can call one of these scripts from the VSCode extension using the `runPythonScript` function in `bridge.ts`. + +When the extension is activated (`activate` function in `src/extension.ts`), we call `setupPythonEnv`, which makes the virtual environment and downloads all the necessary requirements as given in `requirements.txt`. With this in mind, be sure to run `pip freeze > requirements.txt` whenever you add a new requirement. |