From f53768612b1e2268697b5444e502032ef9f3fb3c Mon Sep 17 00:00:00 2001 From: Nate Sesti Date: Tue, 23 May 2023 23:45:12 -0400 Subject: copying from old repo --- extension/scripts/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 extension/scripts/README.md (limited to 'extension/scripts/README.md') 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. -- cgit v1.2.3-70-g09d2