├── .github ├── FUNDING.yml └── ISSUE_TEMPLATE │ ├── bug.yml │ ├── docs.yml │ └── feature.yml ├── .gitignore ├── LICENSE ├── README.md ├── deploy.sh ├── dynamicmacros.py ├── install.sh └── logo.png /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [3dcoded] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: # Replace with a single Buy Me a Coffee username 14 | thanks_dev: # Replace with a single thanks.dev username 15 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 16 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report. 3 | title: "[Bug]: " 4 | labels: ["bug"] 5 | assignees: 6 | - 3dcoded 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thanks for taking the time to fill out this bug report! 12 | - type: textarea 13 | id: what-happened 14 | attributes: 15 | label: What happened? 16 | description: Also tell us, what did you expect to happen? 17 | placeholder: Tell us what you see! 18 | value: "A bug happened!" 19 | validations: 20 | required: true 21 | - type: textarea 22 | id: klippylog 23 | attributes: 24 | label: Klippy Log 25 | description: Upload your "klippy.log" here 26 | placeholder: klippy.log 27 | validations: 28 | required: true -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/docs.yml: -------------------------------------------------------------------------------- 1 | name: Documentation 2 | description: Suggest an improvement to the documentation. 3 | title: "[DOCS]: " 4 | labels: ["documentation"] 5 | assignees: 6 | - 3dcoded 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thanks for taking the time to fill out this documentation issue! 12 | - type: checkboxes 13 | id: what-type 14 | attributes: 15 | label: What kind of documentation issue is this? 16 | description: Choose as many as apply. 17 | options: 18 | - label: Typo 19 | - label: Incorrect information 20 | - label: Unclear information 21 | - label: Missing information 22 | - label: Contradictory information 23 | validations: 24 | required: true 25 | - type: textarea 26 | id: what-docs 27 | attributes: 28 | label: How do you think the documentation should be improved? 29 | description: Tell us about your idea. 30 | placeholder: It would be nice if... 31 | validations: 32 | required: true -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature.yml: -------------------------------------------------------------------------------- 1 | name: Feature Request 2 | description: Suggest an improvement. 3 | title: "[FR]: " 4 | labels: ["enhancement"] 5 | assignees: 6 | - 3dcoded 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: | 11 | Thanks for taking the time to fill out this feature request! 12 | - type: textarea 13 | id: what-feature 14 | attributes: 15 | label: What feature do you want to see? 16 | description: Tell us about your feature request. The more detailed, the better. 17 | placeholder: It would be nice if... 18 | validations: 19 | required: true -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/macos,linux,python 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=macos,linux,python 3 | 4 | ### Linux ### 5 | *~ 6 | 7 | # temporary files which can be created if a process still has a handle open of a deleted file 8 | .fuse_hidden* 9 | 10 | 11 | # KDE directory preferences 12 | .directory 13 | 14 | # Linux trash folder which might appear on any partition or disk 15 | .Trash-* 16 | 17 | .vscode/* 18 | sftp.json 19 | 20 | # .nfs files are created when an open file is removed but is still being accessed 21 | .nfs* 22 | 23 | ### macOS ### 24 | # General 25 | .DS_Store 26 | .AppleDouble 27 | .LSOverride 28 | 29 | # Icon must end with two \r 30 | Icon 31 | 32 | 33 | # Thumbnails 34 | ._* 35 | 36 | # Files that might appear in the root of a volume 37 | .DocumentRevisions-V100 38 | .fseventsd 39 | .Spotlight-V100 40 | .TemporaryItems 41 | .Trashes 42 | .VolumeIcon.icns 43 | .com.apple.timemachine.donotpresent 44 | 45 | # Directories potentially created on remote AFP share 46 | .AppleDB 47 | .AppleDesktop 48 | Network Trash Folder 49 | Temporary Items 50 | .apdisk 51 | 52 | ### macOS Patch ### 53 | # iCloud generated files 54 | *.icloud 55 | 56 | ### Python ### 57 | # Byte-compiled / optimized / DLL files 58 | __pycache__/ 59 | *.py[cod] 60 | *$py.class 61 | 62 | # C extensions 63 | *.so 64 | 65 | # Distribution / packaging 66 | .Python 67 | build/ 68 | develop-eggs/ 69 | dist/ 70 | downloads/ 71 | eggs/ 72 | .eggs/ 73 | lib/ 74 | lib64/ 75 | parts/ 76 | sdist/ 77 | var/ 78 | wheels/ 79 | share/python-wheels/ 80 | *.egg-info/ 81 | .installed.cfg 82 | *.egg 83 | MANIFEST 84 | 85 | # PyInstaller 86 | # Usually these files are written by a python script from a template 87 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 88 | *.manifest 89 | *.spec 90 | 91 | # Installer logs 92 | pip-log.txt 93 | pip-delete-this-directory.txt 94 | 95 | # Unit test / coverage reports 96 | htmlcov/ 97 | .tox/ 98 | .nox/ 99 | .coverage 100 | .coverage.* 101 | .cache 102 | nosetests.xml 103 | coverage.xml 104 | *.cover 105 | *.py,cover 106 | .hypothesis/ 107 | .pytest_cache/ 108 | cover/ 109 | 110 | # Translations 111 | *.mo 112 | *.pot 113 | 114 | # Django stuff: 115 | *.log 116 | local_settings.py 117 | db.sqlite3 118 | db.sqlite3-journal 119 | 120 | # Flask stuff: 121 | instance/ 122 | .webassets-cache 123 | 124 | # Scrapy stuff: 125 | .scrapy 126 | 127 | # Sphinx documentation 128 | docs/_build/ 129 | 130 | # PyBuilder 131 | .pybuilder/ 132 | target/ 133 | 134 | # Jupyter Notebook 135 | .ipynb_checkpoints 136 | 137 | # IPython 138 | profile_default/ 139 | ipython_config.py 140 | 141 | # pyenv 142 | # For a library or package, you might want to ignore these files since the code is 143 | # intended to run in multiple environments; otherwise, check them in: 144 | # .python-version 145 | 146 | # pipenv 147 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 148 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 149 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 150 | # install all needed dependencies. 151 | #Pipfile.lock 152 | 153 | # poetry 154 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 155 | # This is especially recommended for binary packages to ensure reproducibility, and is more 156 | # commonly ignored for libraries. 157 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 158 | #poetry.lock 159 | 160 | # pdm 161 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 162 | #pdm.lock 163 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 164 | # in version control. 165 | # https://pdm.fming.dev/#use-with-ide 166 | .pdm.toml 167 | 168 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 169 | __pypackages__/ 170 | 171 | # Celery stuff 172 | celerybeat-schedule 173 | celerybeat.pid 174 | 175 | # SageMath parsed files 176 | *.sage.py 177 | 178 | # Environments 179 | .env 180 | .venv 181 | env/ 182 | venv/ 183 | ENV/ 184 | env.bak/ 185 | venv.bak/ 186 | 187 | # Spyder project settings 188 | .spyderproject 189 | .spyproject 190 | 191 | # Rope project settings 192 | .ropeproject 193 | 194 | # mkdocs documentation 195 | /site 196 | 197 | # mypy 198 | .mypy_cache/ 199 | .dmypy.json 200 | dmypy.json 201 | 202 | # Pyre type checker 203 | .pyre/ 204 | 205 | # pytype static type analyzer 206 | .pytype/ 207 | 208 | # Cython debug symbols 209 | cython_debug/ 210 | 211 | # PyCharm 212 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 213 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 214 | # and can be added to the global gitignore or merged into this file. For a more nuclear 215 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 216 | #.idea/ 217 | 218 | ### Python Patch ### 219 | # Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration 220 | poetry.toml 221 | 222 | # ruff 223 | .ruff_cache/ 224 | 225 | # LSP config files 226 | pyrightconfig.json 227 | 228 | # End of https://www.toptal.com/developers/gitignore/api/macos,linux,python 229 | .vscode/sftp.json 230 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Klipper Dynamic Macros 2 | 3 | **Never restart Klipper again for simple macros...and so much more** 4 | 5 | logo 6 | 7 | --- 8 | 9 | Klipper Dynamic Macros is an unofficial way to update macros without restarting Klipper, so you can update macros mid-print and see their results live. It also supports extra features that normal GCode Macros don't have. 10 | 11 | ## Documentation 12 | 13 | Read the documentation [here](https://3dcoded.github.io/DynamicMacros) 14 | 15 | [![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) 16 | 17 | ## More Projects 18 | 19 | If you like this project, don't forget to give it a star! Also, check out my other projects: 20 | 21 | - [3MS](https://github.com/3dcoded/3ms), a modular multimaterial system for Klipper 22 | - [KlipperMaintenance](https://github.com/3DCoded/KlipperMaintenance), maintenance reminders for Klipper 23 | 24 | ## Features 25 | 26 | - [Recursion](https://3dcoded.github.io/DynamicMacros/features/recursion) 27 | - [Receiving Variables](https://3dcoded.github.io/DynamicMacros/features/receivingvariables) 28 | - [Utility Functions](https://3dcoded.github.io/DynamicMacros/features/utilities) 29 | - [Variables](https://3dcoded.github.io/DynamicMacros/features/variables) 30 | - [Python](https://3dcoded.github.io/DynamicMacros/features/python) 31 | - [Delayed GCode](https://3dcoded.github.io/DynamicMacros/features/delayed) 32 | - [Macro Clusters](https://3dcoded.github.io/DynamicMacros/features/clusters) 33 | - [Rendering Macros](https://3dcoded.github.io/DynamicMacros/features/rendering) 34 | 35 | ## How Normal Macros Work 36 | 37 | Your macros are written in a `.cfg` file, then included into your `printer.cfg`. When Klipper restarts, it parses these files and saves the macros internally (you can't change them without restarting Klipper). When a macro is called, the cached code is interpreted and run. 38 | 39 | ## How Dynamic Macros Work 40 | 41 | Your macros are written in a `.cfg` file, then the relative path to that file is configured in a `[dynamicmacros]` config section. The config files are read and parsed every time you run the `DYNAMIC_MACRO` command, allowing you to update macros without restarting Klipper. 42 | 43 | ## Get Started 44 | Follow the [Tutorial](https://3dcoded.github.io/DynamicMacros/tutorial) to get started with Dynamic Macros. 45 | 46 | ## Features 47 | 48 | See [Development Status](https://3dcoded.github.io/DynamicMacros/devstatus) for the currently available features, and planned features. 49 | -------------------------------------------------------------------------------- /deploy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | mkdocs gh-deploy 3 | git stash 4 | git checkout gh-pages 5 | echo "dynamicmacros.3dcoded.xyz" > CNAME 6 | git add . 7 | git commit -m "Add CNAME" 8 | git push origin gh-pages 9 | git checkout docs 10 | git stash pop 11 | git add . 12 | git commit -m "chore: Deploy documentation" 13 | git push origin docs -------------------------------------------------------------------------------- /dynamicmacros.py: -------------------------------------------------------------------------------- 1 | import ast 2 | import configparser 3 | import glob 4 | import json 5 | import logging 6 | import textwrap 7 | import os 8 | import re 9 | import subprocess 10 | from io import StringIO 11 | from pathlib import Path 12 | from secrets import token_hex 13 | 14 | DYNAMICMACROS_PATH = Path.home() / 'DynamicMacros' 15 | 16 | import jinja2 17 | 18 | try: 19 | from .gcode_macro import TemplateWrapper # Klipper 20 | except: 21 | from .gcode_macro import TemplateWrapperJinja as TemplateWrapper # Kalico 22 | 23 | # Define the path to the configuration files 24 | config_path = Path(os.path.expanduser('~')) / 'printer_data' / 'config' 25 | 26 | logger = None 27 | 28 | def clean_gcode(gcode): 29 | gcode = '\n' + gcode.strip() + '\n' 30 | gcode = re.sub(r'\n+', '\n', gcode) 31 | gcode = textwrap.indent(gcode, ' '*4) 32 | return gcode.strip() 33 | 34 | class MacroConfigParser: 35 | def __init__(self, printer, delimiter): 36 | global config_path 37 | self.printer = printer 38 | self.delimiter = delimiter 39 | 40 | self.config_file = printer.start_args['config_file'] 41 | self.config_path = Path(os.path.dirname(self.config_file)) 42 | config_path = self.config_path 43 | 44 | def read_config_file(self, filename): 45 | buffer = self._read_file(filename) 46 | sbuffer = StringIO('\n'.join(buffer)) 47 | config = configparser.RawConfigParser( 48 | strict=False, inline_comment_prefixes=(';', '#')) 49 | config.read_file(sbuffer, filename) 50 | return config 51 | 52 | def _read_file(self, filename, visited=[]): 53 | path = self.config_path / filename 54 | if not os.path.exists(path): 55 | raise MissingConfigError(f'Missing Configuration at {path}') 56 | if path in visited: 57 | raise RecursiveConfigError(f'Recursively included file at {path}') 58 | visited.append(path) # Keep a list of files previously included 59 | buffer = [] # List of lines in the file 60 | with open(path, 'r') as file: 61 | for line in file.readlines(): 62 | mo = configparser.RawConfigParser.SECTCRE.match(line) 63 | header = mo and mo.group('header') 64 | # Handle [include xxx.cfg] sections 65 | if header and header.startswith('include '): 66 | include_spec = header[8:].strip() 67 | include_path = str(path.parent / include_spec) 68 | include_filenames = glob.glob(include_path, recursive=True) 69 | for filename in include_filenames: 70 | buffer.extend(self._read_file(filename, visited)) 71 | else: 72 | buffer.append(line) 73 | visited.remove(path) 74 | return buffer 75 | 76 | def extract_macros(self, config): 77 | macros = {} 78 | for section in config.sections(): 79 | logging.info(f'DynamicMacros: Reading section {section}') 80 | if section.startswith('gcode_macro') or \ 81 | section.startswith('delayed_gcode'): 82 | macro = DynamicMacro.from_section( 83 | config, section, DynamicMacros.printer, self.delimiter) 84 | macros[macro.name] = macro 85 | return macros 86 | 87 | def get_workaround_gcode(self, prev_gcode): 88 | lines = [] 89 | for line in prev_gcode.splitlines(): 90 | if '{% set ' in line and 'python' not in line: 91 | lines.append(line) 92 | compiled_gcode = '\n'.join(lines) 93 | return compiled_gcode 94 | 95 | class MissingConfigError(Exception): 96 | pass 97 | 98 | class RecursiveConfigError(Exception): 99 | pass 100 | 101 | class DynamicMacros: 102 | clusters = {} 103 | 104 | def __init__(self, config): 105 | self._init(config) 106 | 107 | def _init(self, config, is_cluster=False): 108 | self.printer = config.get_printer() 109 | self.gcode = self.printer.lookup_object('gcode') 110 | self.fnames = config.getlist('configs') 111 | 112 | self.delimiter = config.get('delimiter', '---') 113 | 114 | if is_cluster: 115 | self.name = config.get_name().split()[1] 116 | DynamicMacros.clusters[self.name] = self 117 | self.python_enabled = config.getboolean('python_enabled', True) 118 | self.printer_enabled = config.getboolean('printer_enabled', True) 119 | else: 120 | self._setup_logging() 121 | DynamicMacros.printer = self.printer 122 | 123 | # Register commands 124 | self.gcode.register_command( 125 | 'DYNAMIC_MACRO', self.cmd_DYNAMIC_MACRO, desc='Run a Dynamic Macro') 126 | self.gcode.register_command( 127 | 'DYNAMIC_RENDER', self.cmd_DYNAMIC_RENDER, desc='Render a Dynamic Macro') 128 | self.gcode.register_command('SET_DYNAMIC_VARIABLE', self.cmd_SET_DYNAMIC_VARIABLE, desc="Set the variable of a Dynamic Macro.") 129 | 130 | self.macros = {} 131 | self.placeholder = DynamicMacro( 132 | 'Error', 'RESPOND MSG="ERROR"', self.printer) 133 | 134 | self.configfile = self.printer.lookup_object('configfile') 135 | 136 | self.config_parser = MacroConfigParser(self.printer, self.delimiter) 137 | 138 | # Interface workaround 139 | # - Allows macros to display on KlipperScreen 140 | # - Allows macro parameters to display on all interfaces 141 | if config.getboolean('interface_workaround', True): 142 | self.interface_workaround() 143 | 144 | self._update_macros() 145 | 146 | self.reactor = self.printer.get_reactor() 147 | self.printer.register_event_handler( 148 | "klippy:ready", self._handle_ready) 149 | 150 | def _setup_logging(self): 151 | # Get git short version hash 152 | try: 153 | result = subprocess.run( 154 | ['git', 'rev-parse', '--short', 'HEAD'], 155 | stdout=subprocess.PIPE, 156 | stderr=subprocess.DEVNULL, 157 | text=True, 158 | check=True, 159 | cwd=DYNAMICMACROS_PATH 160 | ) 161 | git_hash = result.stdout.strip() 162 | except subprocess.CalledProcessError: 163 | git_hash = 'unknown' 164 | 165 | # Setup logging 166 | if not globals().get('LOG_SETUP', False): 167 | logger = logging.Logger('DynamicMacros') 168 | klippy_log = self.printer.start_args['log_file'] 169 | log_dir = os.path.dirname(klippy_log) 170 | mimo_log = os.path.join(log_dir, 'dynamicmacros.log') 171 | handler = logging.FileHandler(mimo_log, mode='w') 172 | formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s') 173 | handler.setFormatter(formatter) 174 | logger.addHandler(handler) 175 | logger.setLevel(logging.DEBUG) 176 | globals()['logging'] = logger 177 | globals()['LOG_SETUP'] = True 178 | logger.info('DynamicMacros Startup') 179 | logger.info(f'Git version: {git_hash}') 180 | 181 | def _handle_ready(self): 182 | self._update_macros() 183 | waketime = self.reactor.monotonic() + 1 184 | self.timer_handler = self.reactor.register_timer( 185 | self._gcode_timer_event, waketime) 186 | 187 | def _gcode_timer_event(self, eventtime): 188 | self._update_macros() 189 | return self.reactor.NEVER 190 | 191 | def interface_workaround(self): 192 | full_cfg = StringIO() 193 | for fname in self.fnames: 194 | cfg = self.config_parser.read_config_file(fname) 195 | for section in cfg.sections(): 196 | if not section.startswith('gcode_macro'): 197 | cfg.remove_section(section) 198 | continue 199 | prev_gcode = cfg.get(section, 'gcode') 200 | compiled_gcode = self.config_parser.get_workaround_gcode(prev_gcode) 201 | if hasattr(self, 'name'): 202 | cmd = f'DYNAMIC_MACRO MACRO={section.split()[1]} CLUSTER={self.name}' + ' {rawparams}' 203 | else: 204 | cmd = f'DYNAMIC_MACRO MACRO={section.split()[1]}' + ' {rawparams}' 205 | cfg.set(section, 'gcode', f'{compiled_gcode}\n{cmd}') 206 | cfg.write(full_cfg) 207 | 208 | # Write cfg to config_path/.dynamicmacros.cfg 209 | with open(config_path / '.dynamicmacros.cfg', 'w+') as file: 210 | file.write(full_cfg.getvalue()) 211 | 212 | # Update printer.cfg to [include .dynamicmacros.cfg] 213 | include_statement = '[include .dynamicmacros.cfg]' 214 | with open(config_path / 'printer.cfg', 'r') as file: 215 | lines = file.readlines() 216 | found = False 217 | for line in lines: 218 | if len(line.strip()) < 1: 219 | # Ignore empty lines 220 | continue 221 | if line.strip()[0] in ('#', ';', '//'): 222 | # Ignore comments 223 | continue 224 | if include_statement in line: 225 | found = True 226 | break 227 | if not found: 228 | lines.insert(0, include_statement+'\n') 229 | 230 | with open(config_path / 'printer.cfg', 'w+') as file: 231 | file.writelines(lines) 232 | 233 | def register_macro(self, macro): 234 | self.macros[macro.name.upper()] = macro 235 | if (macro.name not in self.gcode.ready_gcode_handlers) and (macro.name not in self.gcode.base_gcode_handlers): 236 | _ = self.gcode.register_command(macro.name.upper(), None, desc=macro.desc) 237 | self.gcode.register_command( 238 | macro.name.upper(), self.generate_cmd(macro), desc=macro.desc) 239 | if macro.is_delayed_gcode: 240 | prev = self.gcode.mux_commands.get('UPDATE_DELAYED_GCODE') 241 | if prev is not None: 242 | prev_key, prev_values = prev 243 | prev_values[macro.name] = None 244 | del prev_values[macro.name] 245 | self.gcode.register_mux_command( 246 | 'UPDATE_DELAYED_GCODE', 'ID', macro.name, macro.cmd_UPDATE_DELAYED_GCODE) 247 | self.gcode._build_status_commands() 248 | self.printer.objects[f'gcode_macro {macro.name}'] = macro 249 | # self.configfile.status_raw_config[f'gcode_macro {macro.name}'] = macro.get_status() 250 | original_get_status = self.configfile.get_status 251 | def get_status(eventtime): 252 | status = original_get_status(eventtime) 253 | config = status['config'] 254 | workaround_gcode = self.config_parser.get_workaround_gcode(macro.raw) 255 | config.update({f'gcode_macro {macro.name}': {'gcode': workaround_gcode}}) 256 | status.update({'config': config}) 257 | return status 258 | self.configfile.get_status = get_status 259 | 260 | def cmd_SET_DYNAMIC_VARIABLE(self, gcmd): 261 | macro = gcmd.get('MACRO').upper() 262 | if macro not in self.macros: 263 | for name, cluster in self.clusters.items(): 264 | if macro in cluster.macros: 265 | return cluster._cmd_SET_DYNAMIC_VARIABLE(gcmd) 266 | return self._cmd_SET_DYNAMIC_VARIABLE(gcmd) 267 | 268 | def _cmd_SET_DYNAMIC_VARIABLE(self, gcmd): 269 | name = gcmd.get('MACRO') 270 | variable = gcmd.get('VARIABLE') 271 | value = gcmd.get('VALUE') 272 | 273 | try: 274 | literal = ast.literal_eval(value) 275 | json.dumps(literal, separators=(',', ':')) 276 | except (SyntaxError, TypeError, ValueError) as e: 277 | raise gcmd.error(f"Unable to parse '{value}' as a literal: {e}") 278 | 279 | if name: 280 | macro = self.macros.get(name.upper()) 281 | if macro: 282 | macro.variables[variable] = literal 283 | else: 284 | self.gcode.respond_info(f'ERROR: Macro {name} not found!') 285 | 286 | def unregister_macro(self, macro): 287 | macro.repeat = False 288 | self.gcode.register_command(macro.name.upper(), None) 289 | if macro.is_delayed_gcode: 290 | _, vals = self.gcode.mux_commands.get('UPDATE_DELAYED_GCODE') 291 | if macro.name in vals: 292 | del vals[macro.name] 293 | self.gcode._build_status_commands() 294 | self.macros.pop(macro.name.upper(), None) 295 | 296 | def cmd_DYNAMIC_RENDER(self, gcmd): 297 | cluster = gcmd.get('CLUSTER', None) 298 | if cluster and cluster in self.clusters: 299 | return self.clusters[cluster]._cmd_DYNAMIC_RENDER(gcmd) 300 | return self._cmd_DYNAMIC_RENDER(gcmd) 301 | 302 | def _cmd_DYNAMIC_RENDER(self, gcmd): 303 | try: 304 | # self._update_macros() 305 | logging.info('DynamicMacros Macros:') 306 | for name in self.macros: 307 | logging.info(f' Name: {name}') 308 | macro_name = gcmd.get('MACRO', '').upper() 309 | if macro_name: 310 | params = gcmd.get_command_parameters() 311 | rawparams = gcmd.get_raw_command_parameters() 312 | macro = self.macros.get(macro_name, self.placeholder) 313 | rendered = self._render_macro(macro, params, rawparams) 314 | rendered = re.sub(r'\n+', '\n', rendered) 315 | gcmd.respond_info(f'Rendered {macro.name}:\n\n{rendered}') 316 | except Exception as e: 317 | gcmd.respond_info(str(e)) 318 | 319 | def _render_macro(self, macro, params, rawparams): 320 | rendered = [] 321 | for template in macro.templates: 322 | macro.update_kwparams(template, params, rawparams) 323 | rendered.append(template.template.render(macro.kwparams)) 324 | return '\n'.join(rendered) 325 | 326 | def cmd_DYNAMIC_MACRO(self, gcmd): 327 | cluster_name = gcmd.get('CLUSTER', None) 328 | if cluster_name and cluster_name in self.clusters: 329 | cluster = self.clusters[cluster_name] 330 | return cluster._cmd_DYNAMIC_MACRO(gcmd) 331 | return self._cmd_DYNAMIC_MACRO(gcmd) 332 | 333 | def _cmd_DYNAMIC_MACRO(self, gcmd): 334 | try: 335 | self._update_macros() 336 | logging.info('DynamicMacros Macros:') 337 | for name in self.macros: 338 | logging.info(f' Name: {name}') 339 | macro_name = gcmd.get('MACRO', '') 340 | if macro_name: 341 | params = gcmd.get_command_parameters() 342 | rawparams = gcmd.get_raw_command_parameters() 343 | macro = self.macros.get(macro_name, self.placeholder) 344 | self._run_macro(macro, params, rawparams) 345 | except Exception as e: 346 | gcmd.respond_info(str(e)) 347 | 348 | def generate_cmd(self, macro): 349 | def cmd(gcmd): 350 | params = gcmd.get_command_parameters() 351 | rawparams = gcmd.get_raw_command_parameters() 352 | self._run_macro(macro, params, rawparams) 353 | return cmd 354 | 355 | def _run_macro(self, macro, params, rawparams): 356 | macro.run(params, rawparams) 357 | 358 | def _update_macros(self): 359 | self._unregister_all_macros() 360 | self._load_and_register_macros_from_files() 361 | 362 | def _unregister_all_macros(self): 363 | for macro in list(self.macros.values()): 364 | self.unregister_macro(macro) 365 | 366 | def _load_and_register_macros_from_files(self): 367 | for fname in self.fnames: 368 | self._load_and_register_macros_from_file(fname) 369 | 370 | def _load_and_register_macros_from_file(self, fname): 371 | config = self.config_parser.read_config_file(fname) 372 | new_macros = self.config_parser.extract_macros(config) 373 | self._register_new_macros(new_macros) 374 | 375 | def _register_new_macros(self, new_macros): 376 | for name, macro in new_macros.items(): 377 | self.macros[name] = macro 378 | self.register_macro(macro) 379 | 380 | 381 | class DynamicMacrosCluster(DynamicMacros): 382 | def __init__(self, config): 383 | self._init(config, is_cluster=True) 384 | 385 | def disabled_func(self, name, msg): 386 | def func(*args, **kwargs): 387 | self.gcode.respond_info( 388 | f'WARNING: {name} attempted to {msg} when disabled.') 389 | self.gcode.respond_info( 390 | f'{name} has been blocked from performing a disabled task.') 391 | return func 392 | 393 | def sandboxed_kwparams(self, macro): 394 | def func(template, params, rawparams): 395 | macro._update_kwparams(template, params, rawparams) 396 | if not self.python_enabled: 397 | macro.kwparams['python'] = self.disabled_func( 398 | macro.name, 'run Python code') 399 | macro.kwparams['python_file'] = self.disabled_func( 400 | macro.name, 'run Python file') 401 | if not self.printer_enabled: 402 | macro.kwparams['printer'] = None 403 | return func 404 | 405 | def _run_macro(self, macro, params, rawparams): 406 | macro.update_kwparams = self.sandboxed_kwparams(macro) 407 | macro.run(params, rawparams) 408 | 409 | 410 | class DynamicMacro: 411 | def __init__(self, 412 | name, 413 | raw, 414 | printer, 415 | desc='', 416 | variables={}, 417 | delimiter='---', 418 | rename_existing=None, 419 | initial_duration=None, 420 | repeat=False, 421 | is_delayed_gcode=False): 422 | self.name = name 423 | self.raw = raw 424 | self.printer = printer 425 | self.gcode = self.printer.lookup_object('gcode') 426 | self.desc = desc 427 | self.variables = variables 428 | self.delimiter = delimiter if delimiter != 'NO_DELIMITER' else None 429 | self.rename_existing = rename_existing 430 | self.duration = initial_duration 431 | self.repeat = repeat 432 | self.vars = {} 433 | 434 | self.is_delayed_gcode = is_delayed_gcode 435 | 436 | if self.duration: 437 | self.reactor = self.printer.get_reactor() 438 | self.timer_handler = None 439 | self.inside_timer = self.repeat 440 | self.printer.register_event_handler( 441 | "klippy:ready", self._handle_ready) 442 | 443 | if self.rename_existing: 444 | self.rename() 445 | 446 | if self.delimiter: 447 | self.gcodes = self.raw.split(self.delimiter) 448 | else: 449 | self.gcodes = [self.raw] 450 | self.templates = [self.generate_template( 451 | gcode) for gcode in self.gcodes] 452 | 453 | def _handle_ready(self): 454 | waketime = self.reactor.NEVER 455 | if self.duration: 456 | waketime = self.reactor.monotonic() + self.duration 457 | self.timer_handler = self.reactor.register_timer( 458 | self._gcode_timer_event, waketime) 459 | 460 | def _gcode_timer_event(self, eventtime): 461 | self.inside_timer = True 462 | try: 463 | self.run({}, '') 464 | except Exception: 465 | pass 466 | nextwake = self.reactor.NEVER 467 | if self.repeat: 468 | nextwake = eventtime + self.duration 469 | self.inside_timer = False 470 | return nextwake 471 | 472 | def generate_template(self, gcode): 473 | env = jinja2.Environment('{%', '%}', '{', '}') 474 | logging.info(f'DynamicMacros [{self.name}]: \n{clean_gcode(gcode)}') 475 | return TemplateWrapper(self.printer, env, self.name, gcode) 476 | 477 | def rename(self): 478 | prev_cmd = self.gcode.register_command(self.name, None) 479 | if prev_cmd: 480 | self.gcode.register_command( 481 | self.rename_existing, prev_cmd, desc=f'Renamed from {self.name}') 482 | 483 | def update(self, name, val): 484 | self.vars[name] = val 485 | return val 486 | 487 | def get_macro_variables(self, macro_name): 488 | macro = self.printer.lookup_object(f'gcode_macro {macro_name}') 489 | return macro.variables 490 | 491 | def update_from_dict(self, dictionary): 492 | self.vars.update(dictionary) 493 | return dictionary 494 | 495 | def python(self, python, *args, **kwargs): 496 | key = f'_python{token_hex()}' 497 | 498 | def output(value): 499 | return self.update(key, value) 500 | python_vars = {**self.kwparams, 'output': output, 501 | 'gcode': self.gcode.run_script_from_command, 'printer': self.printer} 502 | python_vars['print'] = lambda *args: self.gcode.run_script_from_command( 503 | 'RESPOND MSG="' + ' '.join(map(str, args)) + '"') 504 | python_vars['args'] = args 505 | python_vars['kwargs'] = kwargs 506 | try: 507 | exec(python, python_vars) 508 | except Exception as e: 509 | self.gcode.respond_info(f'Python Error:\n{e}') 510 | return self.vars.get(key) 511 | 512 | def python_file(self, fname, *args, **kwargs): 513 | try: 514 | with open(config_path / fname, 'r') as file: 515 | text = file.read() 516 | except Exception as e: 517 | self.gcode.respond_info(f'Python file missing: {config_path / fname}') 518 | return 519 | return self.python(text, *args, **kwargs) 520 | 521 | @staticmethod 522 | def from_section(config, section, printer, delimiter): 523 | raw = config.get(section, 'gcode') 524 | raw = clean_gcode(raw) 525 | 526 | name = section.split()[1] 527 | # logging.info(f'DynamicMacros [{name}] Raw:\n{raw}') 528 | 529 | desc = config.get(section, 'description', fallback='No Description') 530 | rename_existing = config.get(section, 'rename_existing', fallback=None) 531 | 532 | initial_duration = config.getfloat( 533 | section, 'initial_duration', fallback=None) 534 | repeat = config.getboolean(section, 'repeat', fallback=False) 535 | is_delayed_gcode = 'delayed_gcode' in section 536 | 537 | variables = {key[len('variable_'):]: value for key, value in config.items( 538 | section) if key.startswith('variable_')} 539 | for k, v in variables.items(): 540 | try: 541 | variables[k] = ast.literal_eval(v) 542 | except: 543 | pass 544 | 545 | return DynamicMacro(name, 546 | raw, 547 | printer, 548 | desc=desc, 549 | variables=variables, 550 | delimiter=delimiter, 551 | rename_existing=rename_existing, 552 | initial_duration=initial_duration, 553 | repeat=repeat, 554 | is_delayed_gcode=is_delayed_gcode) 555 | 556 | def get_status(self, eventtime=None): 557 | return self.variables 558 | 559 | def _update_kwparams(self, template, params, rawparams): 560 | kwparams = {**self.variables, **self.vars, 561 | **template.create_template_context()} 562 | kwparams.update({'params': params, 'rawparams': rawparams, 'update': self.update, 'get_macro_variables': self.get_macro_variables, 563 | 'update_from_dict': self.update_from_dict, 'python': self.python, 'python_file': self.python_file}) 564 | self.kwparams = kwparams 565 | 566 | def update_kwparams(self, template, params, rawparams): 567 | self._update_kwparams(template, params, rawparams) 568 | 569 | def run(self, params, rawparams): 570 | for template in self.templates: 571 | self._run(template, params, rawparams) 572 | 573 | def _run(self, template, params, rawparams): 574 | self.update_kwparams(template, params, rawparams) 575 | template.run_gcode_from_command(self.kwparams) 576 | 577 | # Handle UPDATE_DELAYED_GCODE command 578 | def cmd_UPDATE_DELAYED_GCODE(self, gcmd): 579 | if not self.is_delayed_gcode: 580 | raise gcmd.error('Not a [delayed_gcode]!') 581 | self.duration = gcmd.get_float('DURATION', minval=0) 582 | if self.inside_timer: 583 | self.repeat = (self.duration != 0.) 584 | else: 585 | waketime = self.reactor.NEVER 586 | if self.duration: 587 | waketime = self.reactor.monotonic() + self.duration 588 | self.reactor.update_timer(self.timer_handler, waketime) 589 | 590 | def load_config(config): 591 | return DynamicMacros(config) 592 | 593 | 594 | def load_config_prefix(config): 595 | return DynamicMacrosCluster(config) -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | ln -f dynamicmacros.py ~/klipper/klippy/extras/dynamicmacros.py 3 | echo Installed Klipper Dynamic Macros! -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/3DCoded/DynamicMacros/1d20af98328d7cfd1c7bb58ee37b413d8ffaef29/logo.png --------------------------------------------------------------------------------