aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/tools/vscode-ext.rst
blob: a0f677367c3966908f188f8cd87f45ea8d51c1cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.. _vscode-ext:

Qt Python VSCode Extension
**************************

The `Qt Python extension`_ for Visual Studio Code is a comprehensive development tool
that enhances your PySide6 development workflow with integrated debugging, project
templates, and build tasks.

Installation
============

Install the extension from the Visual Studio Code Marketplace:

1. Open VSCode
2. Go to the Extensions view
3. Search for "Qt Python"
4. Click Install on the extension published by **The Qt Company**

Alternatively, install from the command line:

.. code-block:: bash

    code --install-extension TheQtCompany.qt-python

Features
========

Project Creation
----------------

Create new PySide6 projects using templates:

1. Open the Command Palette
2. Type and select **Qt: Create a new Project or file**
3. Choose from available templates:

   * **Python QtQuick Application** - Creates a Qt Quick/QML project structure
   * **Python QtWidgets Application** - Creates a Qt Widgets project structure

PySide6 Installation
--------------------

Quickly install PySide6 in your current Python environment:

1. Open the Command Palette
2. Type and select **Qt-Python: Install PySide6**

Build Tasks
-----------

The extension provides PySide6-specific tasks accessible via **Tasks: Run Task**:

* **PySide: build** - Build your PySide6 project (compiles UI files, resources, etc.)
* **PySide: run** - Run your PySide6 application
* **PySide: clean** - Clean build artifacts
* **PySide: deploy** - Deploy your application using pyside6-deploy

Debugging
---------

The extension provides debugging capabilities for PySide6 applications with support
for both Python and QML code. See :ref:`tutorial_qml_debugging` for detailed information
on debugging Qt Quick applications with mixed Python/QML debugging.

Learn More
==========

For detailed documentation, feature updates, and usage instructions, visit the
`Qt Python extension marketplace page`_.

.. _`Qt Python extension`: https://marketplace.visualstudio.com/items?itemName=TheQtCompany.qt-python
.. _`Qt Python extension marketplace page`: https://marketplace.visualstudio.com/items?itemName=TheQtCompany.qt-python