-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
97 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,80 @@ | ||
| --- | ||
| hide: | ||
| - toc | ||
| - toc | ||
| --- | ||
|
|
||
| # Cadwork Python Documentation | ||
|
|
||
| In front of you, you see the first version of the Cadwork Python Guide. This document is written in cooperation of the cadwork branches. Since version 27 cadwork offers an API connection to the script language Python. By scripting in cadwork with Python you can automate and customize your operations. | ||
| In front of you, you see the first version of the Cadwork Python Guide. | ||
| This document is written in cooperation of the Cadwork branches. | ||
| Since version 27 Cadwork offers an API connection to the script language Python. | ||
| By scripting in Cadwork with Python you can automate and customize your operations. | ||
|
|
||
| The API provides a multitude of basic functions of cadwork 3D. On the basis of the API external programs can be written, with which it is possible to e.g. create and manipulate parts. | ||
| The API provides a multitude of basic functions of Cadwork 3D. | ||
| On the basis of the API external programs can be written, with which it is possible to e.g. create and manipulate parts. | ||
|
|
||
| List calculations, list outputs, various import and export functions and much more is available via the API. This allows the implementation of customer specific functions without changing the program code of cadwork. By using the API, a wide range of helpers for various areas can be created and directly integrated into cadwork 3D. Cadwork itself delivers some of these small helpers by default. But also the development of small and large helpers by you as a user is possible. | ||
| List calculations, list outputs, various import and export functions and much more is available via the API. | ||
| This allows the implementation of customer specific functions without changing the program code of Cadwork. | ||
| By using the API, a wide range of helpers for various areas can be created and directly integrated into Cadwork 3D. | ||
| Cadwork itself delivers some of these small helpers by default. | ||
| But also the development of small and large helpers by you as a user is possible. | ||
|
|
||
| The Python Guide should enable you to start scripting in cadwork 3D. We hope we can convince you of the great potential with Python in cadwork. | ||
| The Python Guide should enable you to start scripting in Cadwork 3D. | ||
| We hope we can convince you of the great potential with Python in Cadwork. | ||
|
|
||
| ## Discussion - Form | ||
|
|
||
| [GitHub Discussion - Ask and answer questions from the Community](https://github.com/cwapi3d/cwapi3dpython/discussions){target=_blank} :speech_balloon: | ||
| ## Discussions | ||
|
|
||
| [GitHub Discussion - Ask and answer questions from the Community](https://github.com/cwapi3d/cwapi3dpython/discussions){target=_blank} | ||
|
|
||
| ## Introduction | ||
|
|
||
| ### What Is an API? | ||
| An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation. | ||
|
|
||
| {: style="width:700px"} | ||
| An application programming interface (API) is a connection between computers or between computer programs. | ||
| It is a type of software interface, offering a service to other pieces of software. | ||
| A document or standard that describes how to build such a connection or interface is called an API specification. | ||
| A computer system that meets this standard is said to implement or expose an API. | ||
| The term API may refer either to the specification or to the implementation. | ||
|
|
||
| <figure markdown="1"> | ||
| { width="500" } | ||
| </figure> | ||
|
|
||
| ### Why Python? | ||
| ### Why Python? | ||
|
|
||
| * Python is easy to learn. Its syntax is easy and code is very readable. | ||
| * Python has a lot of applications. It's used for developing web applications, data science, rapid application development, and so on. | ||
| * Python allows you to write programs in fewer lines of code than most of the programming languages. | ||
| * The popularity of Python is growing rapidly. Now it's one of the most popular programming languages. | ||
|
|
||
| ### What Is Python? | ||
| ### What Is Python? | ||
|
|
||
| Python is an interpreted, object-oriented, high-level programming language with dynamic semantics. | ||
| Its high-level built in data structures, combined with dynamic typing and dynamic binding, make it very attractive for Rapid Application Development, as well as for use as a scripting or glue language to connect existing components together. | ||
| Python's simple, easy to learn syntax emphasizes readability and therefore reduces the cost of program maintenance. Python supports modules and packages, which encourages program modularity and code reuse. The Python interpreter and the extensive standard library are available in source or binary form without charge for all major platforms, and can be freely distributed. | ||
|
|
||
| Python is an interpreted, object-oriented, high-level programming language with dynamic semantics. Its high-level built in data structures, combined with dynamic typing and dynamic binding, make it very attractive for Rapid Application Development, as well as for use as a scripting or glue language to connect existing components together. Python's simple, easy to learn syntax emphasizes readability and therefore reduces the cost of program maintenance. Python supports modules and packages, which encourages program modularity and code reuse. The Python interpreter and the extensive standard library are available in source or binary form without charge for all major platforms, and can be freely distributed. | ||
| Often, programmers fall in love with Python because of the increased productivity it provides. | ||
| Since there is no compilation step, the edit-test-debug cycle is incredibly fast. | ||
| Debugging Python programs is easy: a bug or bad input will never cause a segmentation fault. | ||
| Instead, when the interpreter discovers an error, it raises an exception. | ||
| When the program doesn't catch the exception, the interpreter prints a stack trace. | ||
| A source level debugger allows inspection of local and global variables, evaluation of arbitrary expressions, setting breakpoints, stepping through the code a line at a time, and so on. | ||
| The debugger is written in Python itself, testifying to Python's introspective power. | ||
| On the other hand, often the quickest way to debug a program is to add a few print statements to the source: the fast edit-test-debug cycle makes this simple approach very effective.[^1] | ||
|
|
||
| Often, programmers fall in love with Python because of the increased productivity it provides. Since there is no compilation step, the edit-test-debug cycle is incredibly fast. Debugging Python programs is easy: a bug or bad input will never cause a segmentation fault. Instead, when the interpreter discovers an error, it raises an exception. When the program doesn't catch the exception, the interpreter prints a stack trace. A source level debugger allows inspection of local and global variables, evaluation of arbitrary expressions, setting breakpoints, stepping through the code a line at a time, and so on. The debugger is written in Python itself, testifying to Python's introspective power. On the other hand, often the quickest way to debug a program is to add a few print statements to the source: the fast edit-test-debug cycle makes this simple approach very effective.[^1] | ||
| [^1]: [python](https://www.python.org/doc/essays/blurb/) | ||
| [^1]: [Python](https://www.python.org/doc/essays/blurb/){target=_blank} | ||
|
|
||
| ```python | ||
| print("Hello cadwork World, let's get started!") | ||
| print("Hello Cadwork! Let's get started!") | ||
| ``` | ||
|
|
||
| Python provides some built-in data types, in particular, [dict](https://docs.python.org/3/library/stdtypes.html#dict){target=_blank}, [list](https://docs.python.org/3/library/stdtypes.html#list){target=_blank}, [set and frozenset](https://docs.python.org/3/library/stdtypes.html#set){target=_blank}, and [tuple](https://docs.python.org/3/library/stdtypes.html#tuple){target=_blank}. The [str](https://docs.python.org/3/library/stdtypes.html#str){target=_blank} class is used to hold Unicode strings, and the [bytes](https://docs.python.org/3/library/stdtypes.html#bytes){target=_blank} and [bytearray](https://docs.python.org/3/library/stdtypes.html#bytearray){target=_blank} classes are used to hold binary data.[^2] | ||
| [^2]: [data types](https://docs.python.org/3/library/datatypes.html) | ||
| Python provides some built-in data types, in particular, [dict](https://docs.python.org/3/library/stdtypes.html#dict){target=_blank}, [list](https://docs.python.org/3/library/stdtypes.html#list){target=_blank}, [set and frozenset](https://docs.python.org/3/library/stdtypes.html#set){target=_blank}, and [tuple](https://docs.python.org/3/library/stdtypes.html#tuple){target=_blank}. | ||
| The [str](https://docs.python.org/3/library/stdtypes.html#str){target=_blank} class is used to hold Unicode strings, and the [bytes](https://docs.python.org/3/library/stdtypes.html#bytes){target=_blank} and [bytearray](https://docs.python.org/3/library/stdtypes.html#bytearray){target=_blank} classes are used to hold binary data.[^2] | ||
|
|
||
| If you are unfamiliar with Python and still want to write helper scripts, I recommend doing a tutorial and then come back to cadwork. :woman_student: <br> | ||
| [^2]: [Data Types](https://docs.python.org/3/library/datatypes.html){target=_blank} | ||
|
|
||
| We recommend following a tutorial and coming back afterward if you are unfamiliar with Python. :woman_student: | ||
|
|
||
| * [The Python Tutorial](https://docs.python.org/3.4/tutorial/){target=_blank} | ||
| * [LearnPython](https://www.learnpython.org/){target=_blank} | ||
| * [RealPython](https://realpython.com/){target=_blank} | ||
|
|
||
| <noscript> | ||
| <img src="https://analytics.cadwork.ca/ingress/e6b1702b-6224-4e93-94b7-9e4c2cd7ae06/pixel.gif"> | ||
| </noscript> | ||
| <script defer src="https://analytics.cadwork.ca/ingress/e6b1702b-6224-4e93-94b7-9e4c2cd7ae06/script.js"></script> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters