Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paulacamargo25 committed Oct 12, 2023
1 parent f9dff97 commit 82797c1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ Note:
- The Python extension offers the python debugger extension as an optional installation, including it during the setup process.
- This extension is supported for all [actively supported versions](https://devguide.python.org/#status-of-python-branches) of the Python language (i.e., Python >= 3.7).


## Intent and Purpose

The primary intent of this extension is to address the following crucial issues:


1. **Independence and Compatibility:** The primary aim of this extension is to offer autonomy to the bundled debugpy implementation, freeing it from dependency on the primary Python extension. This solution tackles a common problem where users encounter challenges debugging with older Python versions (e.g., Python 3.7) as the primary Python extension progresses. Users often face two choices: stick with an older Python extension version and miss out on new features, or upgrade their Python environment, which may not always be feasible. With this extension, you can selectively enable the debugger features, while keeping your main Python extension up-to-date.

2. **Platform-Specific Builds:** Unlike the main Python extension, which bundles all debugpy builds for various platforms into a single extension package, this extension provides a more streamlined approach. It delivers platform-specific builds, ensuring you only receive the components relevant to your specific platform. This reduces unnecessary overhead.

3. **Feature Parity and Ongoing Updates:** This extension replicates all the functionality available in the main Python extension. Any new features introduced in the Python extension will be added here. In the future, the main extension will transition to using this extension for these features.


## Usage

Once installed in Visual Studio Code, python-debugger will be automatically activated when you open a Python file.
Expand Down

0 comments on commit 82797c1

Please sign in to comment.