Skip to content

Commit 54f8db4

Browse files
committed
Update README.
1 parent 117b2c1 commit 54f8db4

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

README.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,36 @@
1-
PyDev.Debugger
2-
===============
1+
# PyDev.Debugger
2+
3+
4+
## New
35

46
Latest `3.x` version: the PyDev debugger now supports `sys.monitoring` which enables
57
really fast tracing on `Python 3.12` (so, if speed is an issue, make sure you upgrade).
68

7-
The PyDev Debugger is a Python debugger which historically was created to
9+
## Important
10+
11+
https://github.com/fabioz/PyDev.Debugger is the main repository
12+
for `pydevd` and the latest versions can always be used directly in:
13+
14+
- [PyDev for Eclipse](http://pydev.org): Enables the usage of `pydevd` in Eclipse (Open Source).
15+
16+
- [Python Debugger (PyDev) for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger): Enables
17+
the usage of `pydevd` in VSCode (note that while `pydevd` itself is open source, this extension is commercial
18+
and helps in the development of the Open Source version. It has a free trial and can be used by acquiring a license for
19+
`PyDev for VSCode` at: https://www.pydev.org/vscode/index.html).
20+
21+
Note that the `Python Debugger (PyDev) for VSCode` may be used as a standalane extension for debugging `Python` by
22+
creating the proper configuration in a `launch.json` and launching it.
23+
24+
Alternatively, [PyDev for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev)
25+
leverages it to offer additional features such as debugging of test cases.
26+
27+
## History / Support
28+
29+
The `PyDev Debugger` (`pydevd` for short) is a **Python debugger** which historically was created to
830
work with `PyDev` (in Eclipse).
931

1032
Over the years (as it's open source -- EPL) it was adopted by other IDEs/companies
11-
(so, it was integrated into PyCharm and VSCode Python through `debugpy`, which bundles `pydevd`).
33+
(so, it was integrated into PyCharm and VSCode Python through `debugpy`, which also bundles `pydevd`).
1234

1335
Note that although it was adopted by other IDEs (and over the years companies of other
1436
commercial IDEs did provide backing), by far most of the work was done without any
@@ -18,21 +40,28 @@ So, if you like using it, please consider becoming a backer of the project (this
1840
done through the `PyDev` umbrella, so please see https://www.pydev.org/about.html
1941
for how to contribute to the project).
2042

43+
44+
## Source code / using
45+
2146
The sources for the PyDev.Debugger may be seen at:
2247

2348
https://github.com/fabioz/PyDev.Debugger
2449

2550
In general, the debugger backend should **NOT** be installed separately if you're using an IDE which already
26-
bundles it (such as PyDev, PyCharm or bundled through debugpy, which is the debug adapter used in
27-
VSCode Python and Visual Studio Python).
51+
bundles it (such as [PyDev for Eclipse](http://pydev.org), [Python Debugger (PyDev) for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger),
52+
PyCharm or the Microsoft Python VSCode Extension, which uses `debugpy`, which is another debug adapter bundling `pydevd` to be used in the Microsoft
53+
VSCode Python Extension and Visual Studio Python).
2854

2955
It is however available in PyPi so that it can be installed for doing remote debugging with `pip` -- so, when
3056
debugging a process which runs in another machine, it's possible to `pip install pydevd` and in the code use
31-
`pydevd.settrace(host='10.1.1.1')` to connect the debugger backend to the debugger UI running in the IDE
57+
`pydevd.settrace(host="10.1.1.1")` (in PyDev) or `pydevd.settrace(host="10.1.1.1", protocol="dap")` (in PyDev for VSCode)
58+
to connect the debugger backend to the debugger UI running in the IDE
3259
(whereas previously the sources had to be manually copied from the IDE installation).
3360

3461
For instructions on how to `Remote Debug` with `PyDev`, see: https://www.pydev.org/manual_adv_remote_debugger.html
3562

63+
For instructions on how to `Remote Debug` with `PyDev for VSCode`, see: https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger
64+
3665
`pydevd` is compatible with Python 3.8 onwards and is tested both with CPython as well as PyPy.
3766

3867
For `Python 3.3 to 3.7` please keep using `pydevd 2.10.0`.

0 commit comments

Comments
 (0)