From 6172beba1a324a9905fb3367caec2638a0fdc730 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 9 Aug 2025 12:16:19 +0200 Subject: [PATCH] [doc] Development Quickstart: debug with the Python Debugger pdb (#5100) Related: - https://github.com/searxng/searxng/pull/5037#issuecomment-3166851578 --- docs/dev/quickstart.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index 305a8686e..973df3b2c 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -34,6 +34,20 @@ choose a meaningful commit message and we are happy to receive your pull request. To not end in *wild west* we have some directives, please pay attention to our ":ref:`how to contribute`" guideline. +.. _pdb: https://docs.python.org/3/library/pdb.html#module-pdb + +If you want to debug with the *good old Python Debugger* pdb_: Alternatively to +``make run`` (2.) which starts a :ref:`searxng granian` server you can jump +into the developer environment and start a python based HTTP server by:: + + $ ./manage dev.env + ... + (dev.env)$ SEARXNG_DEBUG=1 python -m searx.webapp + +Since this is a pure Python solution, you can set breakpoints in your code with +``pdb.set_trace()`` and the debugger will wait for you in the terminal prompt. + + .. sidebar:: further read - :ref:`make nvm`