From 80e433f6efb96a69fcd90b513229ccf0ccf6deda Mon Sep 17 00:00:00 2001 From: Koushik Dutta Date: Sat, 20 May 2023 22:07:40 -0700 Subject: [PATCH] python sample: readme --- plugins/vscode-python/README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/plugins/vscode-python/README.md b/plugins/vscode-python/README.md index 8ca4406f2..ec0b6ebb6 100644 --- a/plugins/vscode-python/README.md +++ b/plugins/vscode-python/README.md @@ -1,15 +1,9 @@ -# @scrypted/vscode-python +# Sample Scrypted Plugin -## npm commands - * npm run scrypted-webpack - * npm run scrypted-deploy - * npm run scrypted-debug - -## scrypted distribution via npm - 1. Ensure package.json is set up properly for publishing on npm. - 2. npm publish - -## Visual Studio Code configuration - -* If using a remote server, edit [.vscode/settings.json](blob/master/.vscode/settings.json) to specify the IP Address of the Scrypted server. -* Launch Scrypted Debugger from the launch menu. +1. npm install +2. Open this plugin directory in VS Code. +3. Edit `.vscode/settings.json` to point to the IP address of your Scrypted server. The default is `127.0.0.1`, your local machine. Also choose the appropriate debug target paths for remote debug source mapping. +4. Press Launch (green arrow button in the Run and Debug sidebar) to start debugging. + * The VS Code `Terminal` area may show an authentication failure and prompt you to log in to the Scrypted Management Console with `npx scrypted login`. You will only need to do this once. You can then relaunch afterwards. + +image