Skip to main content

GUI debugging server accessible on LAN connected devices through a browser

Project description

Graphical Python Debugger

Overview

The Graphical Python Debugger is a network-enabled debugging tool designed to simplify the debugging process for Python applications. This application can be hosted on a local network, allowing multiple devices to participate concurrently in debugging sessions. It also includes a diagram generation feature to provide a visual overview of the Python files within a specified directory. This is a useful learning tool for beginners, and enables easy code reviews with just a command line tool.


Features

1. Directory Diagram Generation

  • Generates a graphical diagram of Python files in a given directory.
  • Displays:
    • Functions
    • Classes (including attributes and methods)
    • Relationships between files.
  • Enables source code viewing directly from the diagram.

2. Experimentation Window

  • Allows users to execute Python code snippets for experimentation during debugging.
  • Provides a sandbox environment to test isolated pieces of code.
  • Syntax highlighting included

3. Debugger Shell

  • Facilitates step-by-step execution of Python files.
  • Core functionalities include:
    • Setting breakpoints.
    • Stepping through code execution.
    • Viewing variable values and their stored information.
    • Inspecting source code.
    • Executing Python expressions during halted execution.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/graphical-python-debugger.git
    cd graphical-python-debugger
    
  2. Install the required dependencies:

    pip install -r requirements.txt
    
  3. Run the application:

    python app.py
    
  4. Access the debugger via your web browser at http://<host_ip>:<port>.

Or just run 'pip install GUIPyDebugger'


Usage

Starting a Debugging Session

  1. Specify the directory containing Python files via the command line tool 'gui_pdb'
  2. The command should look like 'gui_pdb <file_path>'

Experimentation Window

  • Open the experimentation panel.
  • Write and execute Python snippets to test logic or functionality.
  • Keep in mind you can import any of your debug target modules or things in your venv

Debugger Shell

  • Load the desired Python file.
  • Use the controls to:
    • Step through the code.
    • Inspect and manipulate variables.
    • Execute custom Python expressions.

Network Collaboration

  • Host the debugger on a local network to allow other devices to connect.
  • Collaborators can participate in debugging sessions and view/share updates in real-time.

Contribution

Reporting Issues

Feel free to open issues on the GitHub repository for bugs, feature requests, or general feedback.

Pull Requests

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix.
  3. Commit your changes with clear messages.
  4. Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact

For questions or support, please reach out to curlejo.4career@gmail.com or submit an issue on GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

guipydebugger-1.0.7.tar.gz (33.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

GUIPyDebugger-1.0.7-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file guipydebugger-1.0.7.tar.gz.

File metadata

  • Download URL: guipydebugger-1.0.7.tar.gz
  • Upload date:
  • Size: 33.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.1

File hashes

Hashes for guipydebugger-1.0.7.tar.gz
Algorithm Hash digest
SHA256 f7f500f69e74cdadd53baf8fa3de3f0ec45e0f330e7fce7ae37b4fb42179d5ce
MD5 5a9c2cc9d80d45e4891c7a1eebfb36cc
BLAKE2b-256 fcf364a4349054a6340df2268e5c53fc7cab0a4bb61ff390b4a35c30dfc4da48

See more details on using hashes here.

File details

Details for the file GUIPyDebugger-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: GUIPyDebugger-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.1

File hashes

Hashes for GUIPyDebugger-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 636fc8aa07e6f4ee4094cb9354df233f8dbc4ad653421e68e205e6cf3accbe9e
MD5 d7ca848ae2c728fa85f88f1cd28b5d1d
BLAKE2b-256 ccf25a873933e3be5832fbcb0df6cf35c55caa85d8c1e24f3b52cbe2ac7c722f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page