connexion icon indicating copy to clipboard operation
connexion copied to clipboard

[enhancement][docs] vscode launch.json example

Open Lewiscowles1986 opened this issue 1 year ago • 2 comments

Description

Hi, I own licenses to JetBrains products, but prefer to mostly work in VSCode Launching connexion in VSCode for good local-dev is harder than it needs to be.

Sample launch.json (app.py)

Assuming your app is in app.py, and you are just spinning this up without much of an app framework yet

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger:app.py",
            "type": "debugpy",
            "request": "launch",
            "module": "uvicorn",
            "env": {
            },
            "args": [
                "--reload",
                "--port",
                "5001",
                "--host",
                "0.0.0.0",
                "app:app",
            ],
            "jinja": true,
            "autoStartBrowser": false,
            "justMyCode": false,
            "cwd": "${workspaceFolder}",
        },
    ],
}

Sample launch.json (module loading)

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger:{your_module}",
            "type": "debugpy",
            "request": "launch",
            "module": "uvicorn",
            "env": {
            },
            "args": [
                "--reload",
                "--port",
                "5001",
                "--host",
                "0.0.0.0",
                "your_module:app",
            ],
            "jinja": true,
            "autoStartBrowser": false,
            "justMyCode": false,
            "cwd": "${workspaceFolder}",
        },
    ],
}

Of course you'd need uvicorn for this purpose, but it seems to work across AsyncApp, and FlaskApp.

Lewiscowles1986 avatar Jul 25 '24 06:07 Lewiscowles1986

I do not use VSCode myself, but would welcome a PR adding this by someone that does.

RobbeSneyders avatar Dec 23 '24 12:12 RobbeSneyders

I'm happy to PR it. Should come in before the new year, just out at the moment.

Lewiscowles1986 avatar Dec 23 '24 12:12 Lewiscowles1986