Local Dev Docs (windmill-labs#99)

HurricanKai · rubenfiszel · web-flow · commit 72e7e40020dd · 2023-02-22T15:20:01.000+01:00
* Local Dev Docs

* Update index.md

---------

Co-authored-by: Ruben Fiszel &lt;ruben@windmill.dev&gt;
diff --git a/docs/advanced/4_local_development/index.md b/docs/advanced/4_local_development/index.md
@@ -0,0 +1,130 @@
+---
+title: Local Development
+---
+
+# Local Development
+
+## Deno
+
+Windmill deno scripts can be run like normal deno scripts. To add testing or
+debugging code, add this snippet to your file:
+
+```ts
+if (import.meta.main) {
+  // Add your testing & debugging code here.
+}
+```
+
+You can then use your script like normal (for example,
+`deno run -A --watch my_script.ts`), and even write tests inside.
+
+For more information on deno development in general,
+[see the official docs](https://deno.land/manual@v1.30.3/getting_started)
+
+## Python
+
+Windmill python scripts can be run like normal python scripts. To add testing or
+debbug code, add this snippet to your file:
+
+```py
+if __name__ == 'main':
+    # Add your testing & debugging code here.
+    pass
+```
+
+You can then use your script like normal (for example, `python my_script.py`),
+and even write tests inside.
+
+For more information on python development in general,
+[see the official docs](https://www.python.org/doc/)
+
+## Interacting with Windmill locally
+
+Often you will need to test a script locally that also interacts with windmill.
+For example to retrieve resources.
+
+To do so you will need to fill out the context variables that will otherwise be
+filled out by the windmill runtime for you. The most important ones are
+`WM_TOKEN` and `BASE_INTERNAL_URL`. Set `BASE_INTERNAL_URL` to the URL of you windmill instance,
+for example `https://app.windmill.dev`, note that you can never include a
+trailing `/`, or the client will fail to connect. Then set `WM_TOKEN` to a
+token, either create this in the UI, or use [wmill, the CLI](../3_cli/index.md)
+using `wmill user create-token`. Below are some examples on how to do this in
+various environments.
+
+### Terminal
+
+On UNIX platforms you can simply do
+`BASE_INTERNAL_URL=https://app.windmill.dev WM_TOKEN=ThisIsAToken deno run -A my_script.ts`
+with the relevant info provided, the same will work for python.
+
+On windows this is not possible, you will have to use
+[set](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/set_1).
+For example:
+
+```cmd
+set "BASE_INTERNAL_URL=https://app.windmill.dev"
+set "WM_TOKEN=ThisIsAToken"
+```
+
+then simply run the relevant command for your language.
+
+### VSCode
+
+The easiest way to do this is using a launch.json. See how to create one for
+[python](https://code.visualstudio.com/docs/python/debugging) and
+[deno](https://deno.land/manual@v1.9.2/getting_started/debugging_your_code#vscode)
+
+Then add environment files using the "env" section in your configuration.
+
+:::caution
+
+Make sure you are not checking your Token into git.
+
+To easily manage your secrets it may be easier to use a .env file, and add it to
+.gitignore, this is also done below.
+
+:::
+
+For example, for deno:
+
+```json
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Deno",
+      "type": "pwa-node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "deno",
+      "runtimeArgs": ["run", "--inspect-brk", "-A", "${file}"],
+      "env" {
+        "BASE_INTERNAL_URL": "https://app.windmill.dev",
+        "WM_TOKEN": "ThisIsAToken"
+      },
+      "envFile": ".env"
+    }
+  ]
+}
+```
+
+The same `env` & `envFile` options are also supported by python.
+
+### JetBrains IDEs
+
+Especially for python you may prefer using a JetBrains IDE. Simply navigate to
+your
+[run config](https://www.jetbrains.com/help/idea/run-debug-configuration-python.html#1)
+and add two lines
+
+```
+BASE_INTERNAL_URL = https://app.windmill.dev
+WM_TOKEN = ThisIsAToken
+```
+
+:::caution
+
+Make sure you are not checking your Token into git.
+
+:::
