-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
685 lines (506 loc) · 29.9 KB
/
index.html
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Edifice — Edifice 3.2.2 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=84af4edc" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=dcedd534"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
<link rel="icon" href="_static/EdificePyramid.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorial" href="tutorial.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="#">
<img src="_static/EdificePyramid.svg" class="logo__image only-light" alt="Edifice 3.2.2 documentation - Home"/>
<img src="_static/EdificePyramid.svg" class="logo__image only-dark pst-js-only" alt="Edifice 3.2.2 documentation - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="developer_tools.html">
Developer Tools
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="versions.html">
Release Notes
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pyedifice/pyedifice" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorial.html">
Tutorial
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="developer_tools.html">
Developer Tools
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="versions.html">
Release Notes
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pyedifice/pyedifice" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none"></div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="edifice">
<h1>Edifice<a class="headerlink" href="#edifice" title="Link to this heading">#</a></h1>
<p>Edifice is a Python library declarative framework for application user
interfaces.</p>
<ul class="simple">
<li><p>Modern <strong>declarative</strong> UI paradigm from web development.</p></li>
<li><p><strong>100% Python</strong> application development, no language inter-op.</p></li>
<li><p>A <strong>native</strong> Qt desktop app instead of a bundled web browser.</p></li>
<li><p>Fast iteration via <strong>hot-reloading</strong>.</p></li>
</ul>
<p>Edifice uses <a class="reference external" href="https://doc.qt.io/qtforpython-6/">PySide6</a>
or <a class="reference external" href="https://www.riverbankcomputing.com/static/Docs/PyQt6/introduction.html">PyQt6</a>
as a backend. Edifice is like
<a class="reference external" href="https://react.dev/">React</a>, but with
Python instead of JavaScript, and <a class="reference external" href="https://doc.qt.io/qt-6/qtwidgets-index.html">Qt Widgets</a>
instead of the HTML DOM.
If you have React experience, you’ll find Edifice easy to learn.
Edifice has function Components, Props, and Hooks just like React.</p>
<section id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading">#</a></h2>
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption"><span class="caption-text">Installation from <a class="reference external" href="https://pypi.org/project/pyedifice/">pypi.org/project/pyedifice</a></span><a class="headerlink" href="#id3" title="Link to this code">#</a></div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>PySide6-Essentials
pip<span class="w"> </span>install<span class="w"> </span>pyedifice
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id4">
<div class="code-block-caption"><span class="caption-text"><em>Hello World</em> in Edifice</span><a class="headerlink" href="#id4" title="Link to this code">#</a></div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">edifice</span> <span class="kn">import</span> <span class="n">App</span><span class="p">,</span> <span class="n">Label</span><span class="p">,</span> <span class="n">Window</span><span class="p">,</span> <span class="n">component</span>
<span class="nd">@component</span>
<span class="k">def</span> <span class="nf">HelloWorld</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">with</span> <span class="n">Window</span><span class="p">():</span>
<span class="n">Label</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
<span class="n">App</span><span class="p">(</span><span class="n">HelloWorld</span><span class="p">())</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
</pre></div>
</div>
</div>
<p>For more, see the <a class="reference internal" href="tutorial.html"><span class="doc">Tutorial</span></a>.
To understand the core concepts behind Edifice,
see <a class="reference internal" href="edifice.html"><span class="doc">Edifice Core</span></a>.</p>
</section>
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="edifice.html">Edifice Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="base_components.html">Base Elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="hooks.html">Hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="styling.html">Styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="extra.html">Extra Elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utility functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="run_subprocess_with_callback.html">run_subprocess_with_callback</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer_tools.html#dynamic-hot-reload">Dynamic hot-reload</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer_tools.html#element-inspector">Element Inspector</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="versions.html">Release Notes</a></li>
</ul>
</div>
</section>
<section id="why-edifice">
<h2>Why Edifice?<a class="headerlink" href="#why-edifice" title="Link to this heading">#</a></h2>
<section id="declarative">
<h3>Declarative<a class="headerlink" href="#declarative" title="Link to this heading">#</a></h3>
<p>Most existing GUI libraries in Python, such as Tkinter and Qt, operate imperatively.
To create a dynamic application using these libraries,
you must not only think about <em>what</em> widgets to display to the user,
but also <em>how</em> to issue the commands to modify the widgets.</p>
<p>With Edifice the developer
need only declare <em>what</em> is rendered,
not <em>how</em> the content is rendered.</p>
<p>User interactions update the application state, the state renders to a widget tree,
and Edifice modifies the existing widget tree to reflect the new state.</p>
<p>Edifice code looks like this:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">number</span><span class="p">,</span> <span class="n">set_number</span> <span class="o">=</span> <span class="n">use_state</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">with</span> <span class="n">VBoxView</span><span class="p">():</span>
<span class="n">Button</span><span class="p">(</span><span class="s2">"Add 5"</span><span class="p">,</span> <span class="n">on_click</span><span class="o">=</span><span class="k">lambda</span> <span class="n">event</span><span class="p">:</span> <span class="n">set_number</span><span class="p">(</span><span class="n">number</span><span class="o">+</span><span class="mi">5</span><span class="p">))</span>
<span class="n">Label</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">number</span><span class="p">))</span>
<span class="k">if</span> <span class="n">number</span> <span class="o">></span> <span class="mi">30</span> <span class="ow">and</span> <span class="n">number</span> <span class="o"><</span> <span class="mi">70</span><span class="p">:</span>
<span class="n">Label</span><span class="p">(</span><span class="s2">"Number is mid"</span><span class="p">)</span>
</pre></div>
</div>
<p>The GUI displays
a button and a label with the current value of <code class="code docutils literal notranslate"><span class="pre">number</span></code>.
Clicking the button will add 5 to the <code class="code docutils literal notranslate"><span class="pre">number</span></code>.
If the <code class="code docutils literal notranslate"><span class="pre">number</span></code> is “mid” then another label will reveal that fact.</p>
</section>
<section id="put-a-gui-on-useful-python-code">
<h3>Put a GUI on useful Python code<a class="headerlink" href="#put-a-gui-on-useful-python-code" title="Link to this heading">#</a></h3>
<p>The whole point of Edifice is that it’s a way to put a GUI on useful Python
code. If you have a Python script which does a long-running computation,
Edifice provides an API for running that script while presenting
a responsive GUI to the user.</p>
<ol class="arabic simple">
<li><p>Paste the script into an <code class="code docutils literal notranslate"><span class="pre">async</span> <span class="pre">def</span> <span class="pre">worker()</span></code> function.</p></li>
<li><p>Call <a class="reference internal" href="run_subprocess_with_callback.html#edifice.run_subprocess_with_callback" title="edifice.run_subprocess_with_callback"><code class="xref py py-func docutils literal notranslate"><span class="pre">run_subprocess_with_callback()</span></code></a>
on that <code class="code docutils literal notranslate"><span class="pre">worker</span></code> function with a <a class="reference internal" href="stubs/edifice.use_async.html#edifice.use_async" title="edifice.use_async"><code class="xref py py-func docutils literal notranslate"><span class="pre">use_async()</span></code></a>
Hook. Replace the <code class="code docutils literal notranslate"><span class="pre">print</span></code> statements with calls to
<code class="code docutils literal notranslate"><span class="pre">callback</span></code>.</p></li>
</ol>
</section>
<section id="developer-tools">
<h3>Developer Tools<a class="headerlink" href="#developer-tools" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Dynamic hot-reloading of source code changes.</p></li>
<li><p>Element Inspector.</p></li>
</ul>
<p>See <a class="reference internal" href="developer_tools.html"><span class="doc">Developer Tools</span></a> for more details.</p>
</section>
<section id="edifice-vs-qt-quick">
<h3>Edifice vs. Qt Quick<a class="headerlink" href="#edifice-vs-qt-quick" title="Link to this heading">#</a></h3>
<p><a class="reference external" href="https://doc.qt.io/qtforpython-6/PySide6/QtQuick/">Qt Quick</a> is Qt’s declarative GUI framework for Qt.</p>
<p>Qt Quick programs are written in Python + the
special <a class="reference external" href="https://doc.qt.io/qtforpython-6/overviews/qtdoc-qmlapplications.html">QML</a> language + JavaScript.</p>
<p>Edifice programs are written in Python.</p>
<p>Because Edifice programs are only Python, binding to the
UI is much more straightforward.
Edifice makes it easy to dynamically create, mutate, shuffle, and destroy sections of the UI.
Qt Quick assumes a much more static interface.</p>
<p>Qt Quick is like DOM + HTML + JavaScript, whereas Edifice is like React.
QML and HTML are both declarative UI languages but
they require imperative logic in another language for dynamism.
Edifice and React allow fully dynamic applications to be specified
declaratively in one language.</p>
</section>
<section id="extendable">
<h3>Extendable<a class="headerlink" href="#extendable" title="Link to this heading">#</a></h3>
<p>Edifice does not support every feature of Qt,
but it is easy to interface with Qt, either <a class="reference internal" href="base_components.html#custom-widget"><span class="std std-ref">incorporating a Qt Widget</span></a> into an Edifice component,
<a class="reference internal" href="stubs/edifice.Reference.html"><span class="doc">use Qt commands directly</span></a> with an existing Edifice component,
or <a class="reference internal" href="stubs/stubs/edifice.App.export_widgets.html"><span class="doc">incorporating Edifice components</span></a> in a Qt application.</p>
</section>
</section>
<section id="setuptools-build-system">
<h2>Setuptools Build System<a class="headerlink" href="#setuptools-build-system" title="Link to this heading">#</a></h2>
<p>The <em>Setuptools</em> <code class="code docutils literal notranslate"><span class="pre">pyproject.toml</span></code> specifies the package dependecies.</p>
<p>Because Edifice supports PySide6 and PyQt6 at the same time, neither
are required by <code class="code docutils literal notranslate"><span class="pre">dependencies</span></code>. A project which depends
on Edifice should also depend on either
<a class="reference external" href="https://pypi.org/project/PySide6-Essentials/">PySide6-Essentials</a>
or
<a class="reference external" href="https://pypi.org/project/PySide6/">PySide6</a>
or
<a class="reference external" href="https://pypi.org/project/PyQt6/">PyQt6</a>.</p>
<p>Add an Edifice dependency to <code class="code docutils literal notranslate"><span class="pre">pyproject.toml</span></code>:</p>
<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="n">dependencies</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">"pyedifice"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"PySide6-Essentials"</span><span class="p">,</span>
<span class="p">]</span>
</pre></div>
</div>
<p>There are optional dependency groups provided for PySide6-Essentials and PyQt6:</p>
<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span class="n">dependencies</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">"pyedifice [PySide6-Essentials]"</span>
<span class="p">]</span>
</pre></div>
</div>
<p>The <cite>requirements.txt</cite> is generated by</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>uv<span class="w"> </span><span class="nb">export</span><span class="w"> </span>--format<span class="w"> </span>requirements-txt<span class="w"> </span>--no-dev<span class="w"> </span>><span class="w"> </span>requirements.txt
</pre></div>
</div>
</section>
<section id="license-and-code-availability">
<h2>License and Code Availability<a class="headerlink" href="#license-and-code-availability" title="Link to this heading">#</a></h2>
<p>The source code is avaliable <a class="reference external" href="https://github.com/pyedifice/pyedifice">on github/pyedifice</a>.</p>
<p>Edifice is released under the <a class="reference external" href="https://en.wikipedia.org/wiki/MIT_License">MIT License</a>.</p>
<p>Edifice uses Qt under the hood, and both PyQt6 and PySide6 are supported.
Note that PyQt6 is distributed with the <em>GPL</em> license while PySide6 is distributed
under the more flexible <em>LGPL</em> license.</p>
<p>See <a class="reference external" href="https://www.pythonguis.com/faq/pyqt-vs-pyside/">PyQt vs PySide Licensing</a>.</p>
<blockquote>
<div><p><strong>Can I use PySide for commercial applications?</strong></p>
<p>Yes, and you don’t need to release your source code to customers. The LGPL only requires you to release any changes you make to PySide itself.</p>
</div></blockquote>
</section>
<section id="support">
<h2>Support<a class="headerlink" href="#support" title="Link to this heading">#</a></h2>
<p>Submit bug reports or feature requests on
<a class="reference external" href="https://github.com/pyedifice/pyedifice/issues">Github Issues</a>.</p>
<p>Submit questions on
<a class="reference external" href="https://github.com/pyedifice/pyedifice/discussions">Github Discussions</a>.</p>
</section>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="right-next"
href="tutorial.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Tutorial</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-started">Getting Started</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#table-of-contents">Table of Contents</a><ul class="nav section-nav flex-column">
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-edifice">Why Edifice?</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#declarative">Declarative</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#put-a-gui-on-useful-python-code">Put a GUI on useful Python code</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#developer-tools">Developer Tools</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#edifice-vs-qt-quick">Edifice vs. Qt Quick</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#extendable">Extendable</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setuptools-build-system">Setuptools Build System</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#license-and-code-availability">License and Code Availability</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#support">Support</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>