CQ-editor 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. cq_editor-0.3.0/CQ_editor.egg-info/PKG-INFO +406 -0
  2. cq_editor-0.3.0/CQ_editor.egg-info/SOURCES.txt +32 -0
  3. cq_editor-0.3.0/CQ_editor.egg-info/dependency_links.txt +1 -0
  4. cq_editor-0.3.0/CQ_editor.egg-info/entry_points.txt +2 -0
  5. cq_editor-0.3.0/CQ_editor.egg-info/requires.txt +18 -0
  6. cq_editor-0.3.0/CQ_editor.egg-info/top_level.txt +1 -0
  7. cq_editor-0.3.0/LICENSE +201 -0
  8. cq_editor-0.3.0/PKG-INFO +406 -0
  9. cq_editor-0.3.0/README.md +173 -0
  10. cq_editor-0.3.0/cq_editor/__init__.py +1 -0
  11. cq_editor-0.3.0/cq_editor/__main__.py +28 -0
  12. cq_editor-0.3.0/cq_editor/_version.py +1 -0
  13. cq_editor-0.3.0/cq_editor/cq_utils.py +200 -0
  14. cq_editor-0.3.0/cq_editor/cqe_run.py +13 -0
  15. cq_editor-0.3.0/cq_editor/icons.py +59 -0
  16. cq_editor-0.3.0/cq_editor/icons_res.py +9116 -0
  17. cq_editor-0.3.0/cq_editor/main_window.py +349 -0
  18. cq_editor-0.3.0/cq_editor/mixins.py +124 -0
  19. cq_editor-0.3.0/cq_editor/preferences.py +62 -0
  20. cq_editor-0.3.0/cq_editor/utils.py +134 -0
  21. cq_editor-0.3.0/cq_editor/widgets/__init__.py +0 -0
  22. cq_editor-0.3.0/cq_editor/widgets/console.py +81 -0
  23. cq_editor-0.3.0/cq_editor/widgets/cq_object_inspector.py +129 -0
  24. cq_editor-0.3.0/cq_editor/widgets/debugger.py +419 -0
  25. cq_editor-0.3.0/cq_editor/widgets/editor.py +304 -0
  26. cq_editor-0.3.0/cq_editor/widgets/log.py +60 -0
  27. cq_editor-0.3.0/cq_editor/widgets/object_tree.py +397 -0
  28. cq_editor-0.3.0/cq_editor/widgets/occt_widget.py +173 -0
  29. cq_editor-0.3.0/cq_editor/widgets/traceback_viewer.py +99 -0
  30. cq_editor-0.3.0/cq_editor/widgets/viewer.py +392 -0
  31. cq_editor-0.3.0/pyproject.toml +51 -0
  32. cq_editor-0.3.0/setup.cfg +4 -0
  33. cq_editor-0.3.0/setup.py +27 -0
  34. cq_editor-0.3.0/tests/test_app.py +1584 -0
@@ -0,0 +1,406 @@
1
+ Metadata-Version: 2.2
2
+ Name: CQ-editor
3
+ Version: 0.3.0
4
+ Summary: CadQuery plugin to create a mesh of an assembly with corresponding data
5
+ Author: CadQuery Developers
6
+ Maintainer: CadQuery Developers
7
+ License: Apache License
8
+ Version 2.0, January 2004
9
+ http://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ APPENDIX: How to apply the Apache License to your work.
185
+
186
+ To apply the Apache License to your work, attach the following
187
+ boilerplate notice, with the fields enclosed by brackets "[]"
188
+ replaced with your own identifying information. (Don't include
189
+ the brackets!) The text should be enclosed in the appropriate
190
+ comment syntax for the file format. We also recommend that a
191
+ file or class name and description of purpose be included on the
192
+ same "printed page" as the copyright notice for easier
193
+ identification within third-party archives.
194
+
195
+ Copyright [yyyy] [name of copyright owner]
196
+
197
+ Licensed under the Apache License, Version 2.0 (the "License");
198
+ you may not use this file except in compliance with the License.
199
+ You may obtain a copy of the License at
200
+
201
+ http://www.apache.org/licenses/LICENSE-2.0
202
+
203
+ Unless required by applicable law or agreed to in writing, software
204
+ distributed under the License is distributed on an "AS IS" BASIS,
205
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
206
+ See the License for the specific language governing permissions and
207
+ limitations under the License.
208
+
209
+ Project-URL: Repository, https://github.com/CadQuery/CQ-editor.git
210
+ Project-URL: Bug Tracker, https://github.com/CadQuery/CQ-editor/issues
211
+ Keywords: cadquery,CAD,engineering,design
212
+ Classifier: Development Status :: 4 - Beta
213
+ Classifier: Programming Language :: Python
214
+ Requires-Python: <3.13,>=3.9
215
+ Description-Content-Type: text/markdown
216
+ License-File: LICENSE
217
+ Requires-Dist: cadquery
218
+ Requires-Dist: pyqtgraph
219
+ Requires-Dist: spyder==5
220
+ Requires-Dist: path
221
+ Requires-Dist: logbook
222
+ Requires-Dist: requests
223
+ Requires-Dist: qtconsole==5.4.1
224
+ Provides-Extra: test
225
+ Requires-Dist: pytest; extra == "test"
226
+ Requires-Dist: pluggy; extra == "test"
227
+ Requires-Dist: pytest-qt; extra == "test"
228
+ Requires-Dist: pytest-mock; extra == "test"
229
+ Requires-Dist: pytest-repeat; extra == "test"
230
+ Requires-Dist: pyvirtualdisplay; extra == "test"
231
+ Provides-Extra: dev
232
+ Requires-Dist: black; extra == "dev"
233
+
234
+ # CadQuery editor
235
+
236
+ [![Build status](https://ci.appveyor.com/api/projects/status/g98rs7la393mgy91/branch/master?svg=true)](https://ci.appveyor.com/project/adam-urbanczyk/cq-editor/branch/master)
237
+ [![codecov](https://codecov.io/gh/CadQuery/CQ-editor/branch/master/graph/badge.svg)](https://codecov.io/gh/CadQuery/CQ-editor)
238
+ [![Build Status](https://dev.azure.com/cadquery/CQ-editor/_apis/build/status/CadQuery.CQ-editor?branchName=master)](https://dev.azure.com/cadquery/CQ-editor/_build/latest?definitionId=3&branchName=master)
239
+ [![DOI](https://zenodo.org/badge/136604983.svg)](https://zenodo.org/badge/latestdoi/136604983)
240
+
241
+ CadQuery GUI editor based on PyQT supports Linux, Windows and Mac.
242
+
243
+ <img src="https://github.com/CadQuery/CQ-editor/raw/master/screenshots/screenshot2.png" alt="Screenshot" width="70%" >
244
+ <img src="https://github.com/CadQuery/CQ-editor/raw/master/screenshots/screenshot3.png" alt="Screenshot" width="70%" >
245
+ <img src="https://github.com/CadQuery/CQ-editor/raw/master/screenshots/screenshot4.png" alt="Screenshot" width="70%" >
246
+
247
+ ## Notable features
248
+
249
+ * Automatic code reloading - you can use your favourite editor
250
+ * OCCT based
251
+ * Graphical debugger for CadQuery scripts
252
+ * Step through script and watch how your model changes
253
+ * CadQuery object stack inspector
254
+ * Visual inspection of current workplane and selected items
255
+ * Insight into evolution of the model
256
+ * Export to various formats
257
+ * STL
258
+ * STEP
259
+
260
+ ## Installation - Pre-Built Packages (Recommended)
261
+
262
+ ~~### Release Packages~~
263
+
264
+ ~~Stable release builds which do not require Anaconda are attached to the [latest release](https://github.com/CadQuery/CQ-editor/releases). Download installer for your operating system, extract it, and run the CQ-editor script for your OS (CQ-editor.cmd for Windows, CQ-editor.sh for Linux and MacOS). On Windows you should be able to simply double-click on CQ-editor.cmd. On Linux and MacOS you may need to make the script executable with `chmod +x CQ-editor.sh` and run the script from the command line. The script contains an environment variable export that may be required to get CQ-editor to launch correctly on MacOS Big Sur, so it is better to use the script than to launch CQ-editor directly.~~
265
+
266
+ ### Development Packages
267
+
268
+ Development builds are also available, but can be unstable and should be used at your own risk. You can download the newest build [here](https://github.com/CadQuery/CQ-editor/releases/tag/nightly). Install and run the `run.sh` (Linux/MacOS) or `run.bat` (Windows) script in the root CQ-editor directory. The CQ-editor window should launch.
269
+
270
+ ### MacOS workarounds
271
+
272
+ On later MacOS versions you may also need `xattr -r -d com.apple.quarantine path/to/CQ-editor-MacOS`.
273
+
274
+ ## Installation (conda/mamba)
275
+
276
+ Use conda or mamba to install:
277
+ ```
278
+ mamba install -c cadquery -c conda-forge cq-editor=master
279
+ ```
280
+ and then simply type `cq-editor` to run it. This installs the latest version built directly from the HEAD of this repository.
281
+
282
+ Alternatively clone this git repository and set up the following conda environment:
283
+ ```
284
+ mamba env create -f cqgui_env.yml -n cqgui
285
+ mamba activate cqgui
286
+ python run.py
287
+ ```
288
+
289
+ If you are concerned about mamba/conda modifying your shell settings, you can use [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html):
290
+ ```
291
+ micromamba install -n base -c cadquery cq-editor
292
+ micromamba run -n base cq-editor
293
+ ```
294
+
295
+ On some linux distributions (e.g. `Ubuntu 18.04`) it might be necessary to install additonal packages:
296
+ ```
297
+ sudo apt install libglu1-mesa libgl1-mesa-dri mesa-common-dev libglu1-mesa-dev
298
+ ```
299
+ On Fedora 29 the packages can be installed as follows:
300
+ ```
301
+ dnf install -y mesa-libGLU mesa-libGL mesa-libGLU-devel
302
+ ```
303
+
304
+ ## Usage
305
+
306
+ ### Showing Objects
307
+
308
+ By default, CQ-editor will display a 3D representation of all `Workplane` objects in a script with a default color and alpha (transparency). To have more control over what is shown, and what the color and alpha settings are, the `show_object` method can be used. `show_object` tells CQ-editor to explicity display an object, and accepts the `options` parameter. The `options` parameter is a dictionary of rendering options named `alpha` and `color`. `alpha` is scaled between 0.0 and 1.0, with 0.0 being completely opaque and 1.0 being completely transparent. The color is set using R (red), G (green) and B (blue) values, and each one is scaled from 0 to 255. Either option or both can be omitted. The `name` parameter can assign a custom name which will appear in the objects pane of CQ-editor.
309
+
310
+ ```python
311
+ show_object(result, name="somename", options={"alpha":0.5, "color": (64, 164, 223)})
312
+ ```
313
+
314
+ Note that `show_object` works for `Shape` and `TopoDS_Shape` objects too. In order to display objects from the embedded Python console use `show`.
315
+
316
+ ### Rotate, Pan and Zoom the 3D View
317
+
318
+ The following mouse controls can be used to alter the view of the 3D object, and should be familiar to CAD users, even if the mouse buttons used may differ.
319
+
320
+ * _Left Mouse Button_ + _Drag_ = Rotate
321
+ * _Middle Mouse Button_ + _Drag_ = Pan
322
+ * _Right Mouse Button_ + _Drag_ = Zoom
323
+ * _Mouse Wheel_ = Zoom
324
+
325
+ ### Debugging Objects
326
+
327
+ There are multiple menu options to help in debugging a CadQuery script. They are included in the `Run` menu, with corresponding buttons in the toolbar. Below is a listing of what each menu item does.
328
+
329
+ * `Debug` (Ctrl + F5) - Instead of running the script completely through as with the `Render` item, it begins executing the script but stops at the first non-empty line, waiting for the user to continue execution manually.
330
+ * `Step` (Ctrl + F10) - Will move execution of the script to the next non-empty line.
331
+ * `Step in` (Ctrl + F11) - Will follow the flow of execution to the inside of a user-created function defined within the script.
332
+ * `Continue` (Ctrl + F12) - Completes execution of the script, starting from the current line that is being debugged.
333
+
334
+ It is also possible to do visual debugging of objects. This is possible by using the `debug()` function to display an object instead of `show_object()`. An alternative method for the following code snippet is shown below for highlighting a specific face, but it demonstrates one use of `debug()`.
335
+ ```python
336
+ import cadquery as cq
337
+
338
+ result = cq.Workplane().box(10, 10, 10)
339
+
340
+ highlight = result.faces('>Z')
341
+
342
+ show_object(result, name='box')
343
+ debug(highlight)
344
+ ```
345
+ Objects displayed with `debug()` are colored in red and have their alpha set so they are semi-transparent. This can be useful for checking for interference, clearance, or whether the expected face is being selected, as in the code above.
346
+
347
+ ### Console Logging
348
+
349
+ Python's standard `print()` function will not output to the CQ-editor GUI, and `log()` should be used instead. `log()` will output the provided text to the _Log viewer_ panel, providing another way to debug CadQuery scripts. If you started CQ-editor from the command line, the `print()` function will output text back to it.
350
+
351
+ ### Using an External Code Editor
352
+
353
+ Some users prefer to use an external code editor instead of the built-in Spyder-based editor that comes stock with CQ-editor. The steps below should allow CQ-editor to work alongside most text editors.
354
+
355
+ 1. Open the Preferences dialog by clicking `Edit->Preferences`.
356
+ 2. Make sure that `Code Editor` is selected in the left pane.
357
+ 3. Check `Autoreload` in the right pane.
358
+ 4. If CQ-editor is not catching the saves from your external editor, increasing `Autoreload delay` in the right pane may help. This issue has been reported when using vim or emacs.
359
+
360
+ ### Exporting an Object
361
+
362
+ Any object can be exported to either STEP or STL format. The steps for doing so are listed below.
363
+
364
+ 1. Highlight the object to be exported in the _Objects_ panel.
365
+ 2. Click either `Export as STL` or `Export as STEP` from the `Tools` menu, depending on which file format you want to export. Both of these options will be disabled if an object is not selected in the _Objects_ panel.
366
+
367
+ Clicking either _Export_ item will present a file dialog that allows the file name and location of the export file to be set.
368
+
369
+ ### Displaying All Wires for Debugging
370
+
371
+ **NOTE:** This is intended for debugging purposes, and if not removed, could interfere with the execution of your model in some cases.
372
+
373
+ Using `consolidateWires()` is a quick way to combine all wires so that they will display together in CQ-editor's viewer. In the following code, it is used to make sure that both rects are displayed. This technique can make it easier to debug in-progress 2D sketches.
374
+
375
+ ```python
376
+ import cadquery as cq
377
+ res = cq.Workplane().rect(1,1).rect(3,3).consolidateWires()
378
+ show_object(res)
379
+ ```
380
+
381
+ ### Highlighting a Specific Face
382
+
383
+ Highlighting a specific face in a different color can be useful when debugging, or when trying to learn CadQuery selectors. The following code creates a separate, highlighted object to show the selected face in red. This is an alternative to using a `debug()` object, and in most cases `debug()` will provide the same result with less code. However, this method will allow the color and alpha of the highlight object to be customized.
384
+
385
+ ```python
386
+ import cadquery as cq
387
+
388
+ result = cq.Workplane().box(10, 10, 10)
389
+
390
+ highlight = result.faces('>Z')
391
+
392
+ show_object(result)
393
+ show_object(highlight,'highlight',options=dict(alpha=0.1,color=(1.,0,0)))
394
+ ```
395
+
396
+ ### Naming an Object
397
+
398
+ By default, objects have a randomly generated ID in the object inspector. However, it can be useful to name objects so that it is easier to identify them. The `name` parameter of `show_object()` can be used to do this.
399
+
400
+ ```python
401
+ import cadquery as cq
402
+
403
+ result = cq.Workplane().box(10, 10, 10)
404
+
405
+ show_object(result, name='box')
406
+ ```
@@ -0,0 +1,32 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ setup.py
5
+ CQ_editor.egg-info/PKG-INFO
6
+ CQ_editor.egg-info/SOURCES.txt
7
+ CQ_editor.egg-info/dependency_links.txt
8
+ CQ_editor.egg-info/entry_points.txt
9
+ CQ_editor.egg-info/requires.txt
10
+ CQ_editor.egg-info/top_level.txt
11
+ cq_editor/__init__.py
12
+ cq_editor/__main__.py
13
+ cq_editor/_version.py
14
+ cq_editor/cq_utils.py
15
+ cq_editor/cqe_run.py
16
+ cq_editor/icons.py
17
+ cq_editor/icons_res.py
18
+ cq_editor/main_window.py
19
+ cq_editor/mixins.py
20
+ cq_editor/preferences.py
21
+ cq_editor/utils.py
22
+ cq_editor/widgets/__init__.py
23
+ cq_editor/widgets/console.py
24
+ cq_editor/widgets/cq_object_inspector.py
25
+ cq_editor/widgets/debugger.py
26
+ cq_editor/widgets/editor.py
27
+ cq_editor/widgets/log.py
28
+ cq_editor/widgets/object_tree.py
29
+ cq_editor/widgets/occt_widget.py
30
+ cq_editor/widgets/traceback_viewer.py
31
+ cq_editor/widgets/viewer.py
32
+ tests/test_app.py
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ CQ-editor = cq_editor.cqe_run:main
@@ -0,0 +1,18 @@
1
+ cadquery
2
+ pyqtgraph
3
+ spyder==5
4
+ path
5
+ logbook
6
+ requests
7
+ qtconsole==5.4.1
8
+
9
+ [dev]
10
+ black
11
+
12
+ [test]
13
+ pytest
14
+ pluggy
15
+ pytest-qt
16
+ pytest-mock
17
+ pytest-repeat
18
+ pyvirtualdisplay
@@ -0,0 +1 @@
1
+ cq_editor
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.