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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
|project|
*********
.. ifconfig:: output_format == 'html'
**Qt for Python** offers the official Python bindings for `Qt`_,
which enables you to use Python to write your Qt applications.
The project has two main components:
* `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
* `Shiboken6 <shiboken6/index.html>`__, a binding generator tool, which can
be used to expose C++ projects to Python, and a Python module with
some utility functions.
.. ifconfig:: output_format == 'qthelp'
**Qt for Python** offers the official Python bindings for `Qt`_,
which enables you to use Python to write your Qt applications.
The project has two main components:
* `PySide6`_, so that you can use Qt6 APIs in your Python applications, and
* `Shiboken6 <../shiboken6/index.html>`__, a binding generator tool, which can
be used to expose C++ projects to Python, and a Python module with
some utility functions.
`Porting from PySide2 to PySide6`_ provides information on porting existing PySide2
applications.
This project is available under the LGPLv3/GPLv3 and the `Qt commercial license`_.
.. _Qt: https://doc.qt.io
.. _PySide6: quickstart.html
.. _`Qt commercial license`: https://www.qt.io/licensing/
.. _`Porting from PySide2 to PySide6`: gettingstarted/porting_from2.html
Quick Start
===========
You can obtain the latest stable version by running ``pip install pyside6``.
If you want to build it yourself, check the `getting started guide`_.
To learn how to use it, check out `write your first application`_,
and to learn what is installed with the ``pyside6``, check the
`package content, structure, and tools`_ page.
.. _`getting started guide`: gettingstarted/index.html
.. _`write your first application`: quickstart.html
.. _`package content, structure, and tools`: gettingstarted/package_details.html
Documentation
=============
.. grid:: 1 3 3 3
:gutter: 2
.. grid-item-card::
:img-top: images/Desktop.svg
:class-item: text-center
Write your first Qt application.
+++
.. button-ref:: quick-start
:color: primary
:outline:
:expand:
Start here!
.. grid-item-card::
:img-top: images/Support.svg
:class-item: text-center
Modules, docs, and cross compilation.
+++
.. button-ref:: gettingstarted/index
:color: primary
:outline:
:expand:
Build Instructions
.. grid-item-card::
:img-top: images/Commercial.svg
:class-item: text-center
Packages, installation, and details.
+++
.. button-ref:: commercial-page
:color: primary
:outline:
:expand:
Commercial
.. grid-item-card::
:img-top: images/Dev.svg
:class-item: text-center
PySide API reference.
+++
.. button-ref:: pyside-api
:color: primary
:outline:
:expand:
API Docs
.. grid-item-card::
:img-top: images/Tutorials.svg
:class-item: text-center
Learn with step-by-step guides.
+++
.. button-ref:: tutorials/index
:color: primary
:outline:
:expand:
Tutorials
.. grid-item-card::
:img-top: images/Examples.svg
:class-item: text-center
Check all the available examples.
+++
.. button-ref:: examples/index
:color: primary
:outline:
:expand:
Examples
.. grid-item-card::
:img-top: images/Training.svg
:class-item: text-center
Watch webinars, talks, and more.
+++
.. button-ref:: videos
:color: primary
:outline:
:expand:
Videos
.. grid-item-card::
:img-top: images/Tooling.svg
:class-item: text-center
Discover the tools included.
+++
.. button-ref:: package_tools
:color: primary
:outline:
:expand:
Tooling
.. grid-item-card::
:img-top: images/Deployment.svg
:class-item: text-center
Learn to deploy your applications.
+++
.. button-ref:: deployment-guides
:color: primary
:outline:
:expand:
Deployment
.. grid-item-card::
:img-top: images/cpp_python.svg
:class-item: text-center
Generate C++ to Python bindings.
+++
.. button-link:: shiboken6/index.html
:color: primary
:outline:
:expand:
Shiboken
.. grid-item-card::
:img-top: images/stopwatch.svg
:class-item: text-center
API differences and known issues.
+++
.. button-ref:: considerations
:color: primary
:outline:
:expand:
Considerations
.. grid-item-card::
:img-top: images/Development.svg
:class-item: text-center
Notes for Developers.
+++
.. button-ref:: developer-notes
:color: primary
:outline:
:expand:
Developers
We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community.
.. _`wiki page`: https://wiki.qt.io/Qt_for_Python
.. toctree::
:hidden:
:glob:
contents.rst
|
