pycharm-remote-debugger

Easily debug your remote project


License
MIT
Install
pip install pycharm-remote-debugger==0.1.7

Documentation

Pycharm Remote Debugger

With PyCharm you can debug your application using an interpreter that is located on the other computer, for example, on a web server or dedicated test machine.

Installation

pip install pycharm_remote_debugger

Steps

  1. Create a deployment configuration for a remote interpreter.
    • Ensure that you have SSH access to the remote machine
  2. Deploy your application to a remote host
  3. Create a Python Debug Server run/debug configuration
    • Specify the port number, and the IDE host address
    • Map the path on the local machine to the path on the remote machine
  4. Make sure you are installing pycharm_remote_debugger on the remote machine/container
  5. Run your software using pycharm_remote_debugger module:
    • Create and entry point file that execute your code and login to the debugger.
    from pycharm_remote_debugger import PycharmRemoteDebugger
    
    remote_addr = "10.2.55.1"
    port = 6789
    
    debugger = PycharmRemoteDebugger(remote_addr, int(port))
    debugger.debug()
    
    main()  # run your software here
    • Use the command line:
    python -m pycharm_remote_debugger -r 10.2.55.1 -p 6789 -m my_module_name -k module_arg1 -s -k module_arg2
  6. Start debugger on pycharm
  7. Debug your program :)

Arguments: