kludex / fastapi-docker-debug

Need to debug your FastAPI application with Docker? Don't worry! :sunglasses:

Warning Now that VSCode natevily supports FastAPI for debugging purposes, I'll archive this project.

Debug FastAPI Applications on Docker 🐋

This is a very simple demonstration on how to debug your FastAPI application via Docker container. 😎

We'll make use of the following tools:

• Docker
• Docker-compose

So please, if you don't have them installed, feel free to do so.

Usage 🖥️

Very simple app and usage. Let's not complicate things here! 😇

Build and run your docker-compose with the following command:

docker-compose -f docker-compose.debug.yaml up

Ok, what's happening? Looks like the process is hanging, but don't worry!

Go to your VSCode and press F5.

At this point, our debugger is connected! You now can add breaking points and debug your applications! 😙

License 📖

This project is licensed under the terms of the MIT license.

fastapi-docker-debug's Issues

wait-for-client never terminating

Greetings @Kludex thank you for this repo. I am trying to use this with my application, however it seems that when adding wait-for-client it never returns, hence the application never starts. Do you know what could be going on here?

Part of my docker-compose file:

command: >
      sh -c "
        pip install debugpy && 
        python wait_for_localstack_ready.py &&
        python -m debugpy --wait-for-client --listen 0.0.0.0:5678 -m uvicorn app.main:app --host 0.0.0.0 --port 80 --reload
      "

Without works without any problems.

command: >
      sh -c "
        python wait_for_localstack_ready.py &&
        uvicorn app.main:app --host 0.0.0.0 --port 80 --reload
      "

It works now, I had the wrong path in launch.json configured, d'oh!