├── .circleci ├── config.yml ├── ghpages-config.yml └── scripts │ └── use-kicad-python.ps1 ├── .gitignore ├── LICENSE ├── README.md ├── dev-requirements.txt ├── metadata.json ├── pyproject.toml ├── pytest.ini ├── release └── deploy.sh ├── resources ├── how-to-commit.png ├── icon.png ├── pcm.png └── toolbar.png ├── source ├── __init__.py ├── git.py ├── git_plugin_action.py └── icon.png └── tests ├── __init__.py ├── conftest.py ├── test_git.py └── test_plugin.py /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | jobs: 4 | test-linux: 5 | parameters: 6 | version: 7 | type: string 8 | docker: 9 | - image: admwscki/kicad-kbplacer-primary:<> 10 | steps: 11 | - checkout 12 | - run: 13 | name: Prepare tests 14 | command: | 15 | pip3 install --no-cache-dir -r dev-requirements.txt 16 | - run: 17 | name: Run tests 18 | command: | 19 | pytest --junitxml=test-results/pytest/results.xml tests/ 20 | - store_test_results: 21 | path: test-results 22 | - when: # run only on master and one kicad selected version 23 | condition: 24 | and: 25 | - equal: [ 8.0.0-mantic, << parameters.version >> ] 26 | - equal: [ master, << pipeline.git.branch >> ] 27 | steps: 28 | - run: 29 | name: Publish coverage 30 | command: | 31 | pip3 install coveralls 32 | python3 -m coveralls 33 | test-windows-kicad7: 34 | machine: 35 | image: windows-server-2022-gui:current 36 | shell: powershell.exe -ExecutionPolicy Bypass 37 | resource_class: windows.medium 38 | steps: 39 | - checkout 40 | - restore_cache: 41 | key: scoop-{{ .Branch }}-{{ checksum "dev-requirements.txt" }} 42 | - run: 43 | name: Install scoop and KiCad 44 | command: | 45 | irm get.scoop.sh -outfile "install.ps1" 46 | .\install.ps1 -RunAsAdmin -ScoopDir "C:\scoop" 47 | scoop bucket add extras 48 | scoop install kicad@7.0.9 49 | scoop cache rm --all 50 | - run: 51 | name: Install dependencies 52 | command: | 53 | .\.circleci\scripts\use-kicad-python.ps1 54 | python -m pip install --upgrade pip 55 | pip install --no-cache-dir -r dev-requirements.txt 56 | - save_cache: 57 | key: scoop-{{ .Branch }}-{{ checksum "dev-requirements.txt" }} 58 | paths: 59 | - C:\scoop 60 | - run: 61 | name: Run tests 62 | command: | 63 | ..\.circleci\scripts\use-kicad-python.ps1 64 | pytest --junitxml=test-results/pytest/results.xml 65 | working_directory: tests 66 | - store_test_results: 67 | path: tests/test-results 68 | create-pcm-package: 69 | docker: 70 | - image: cimg/python:3.11 71 | steps: 72 | - checkout 73 | - run: 74 | name: Setup environment variables 75 | command: | 76 | if [ -z "$CIRCLE_TAG" ]; then 77 | echo "Building development package" 78 | else 79 | echo "Building release package" 80 | echo "export PLUGIN_KICAD_STATUS=stable" >> $BASH_ENV 81 | echo "export PLUGIN_KICAD_RELEASE_URL=https://github.com/adamws/kicad-git/releases/download/v{version}/{zip_name}" >> $BASH_ENV 82 | fi 83 | - run: 84 | name: Install dependencies 85 | command: | 86 | python -m pip install --upgrade hatch 87 | - run: 88 | name: Create zip package and repository 89 | environment: 90 | HATCH_BUILD_HOOK_ENABLE_KICAD-REPOSITORY: true 91 | command: | 92 | python -m hatch build --target kicad-package 93 | - store_artifacts: 94 | path: dist/repository 95 | - when: # run only on master 96 | condition: 97 | equal: [ master, << pipeline.git.branch >> ] 98 | steps: 99 | - add_ssh_keys: 100 | fingerprints: 101 | - "8f:40:c5:cb:fe:d1:a7:e1:ab:46:f6:f0:ba:4e:10:15" 102 | - run: 103 | name: Deploy repository to github pages 104 | command: | 105 | ./release/deploy.sh 106 | 107 | workflows: 108 | main: 109 | jobs: 110 | - test-linux: 111 | matrix: 112 | parameters: 113 | version: 114 | - 7.0.11-mantic 115 | - 8.0.0-mantic 116 | - test-windows-kicad7 117 | - create-pcm-package: 118 | requires: 119 | - test-linux 120 | - test-windows-kicad7 121 | kicad-release: 122 | jobs: 123 | - create-pcm-package: 124 | filters: 125 | tags: 126 | only: /^v[0-9]+(\.[0-9]+)*$/ 127 | branches: 128 | ignore: /.*/ 129 | -------------------------------------------------------------------------------- /.circleci/ghpages-config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | # dummy config, to satisfy circleci on automatic ghpages deployment 4 | 5 | jobs: 6 | build: 7 | docker: 8 | - image: cimg/base:2022.09 9 | steps: 10 | - run: echo "Deployment ok" 11 | 12 | workflows: 13 | main: 14 | jobs: 15 | - build 16 | -------------------------------------------------------------------------------- /.circleci/scripts/use-kicad-python.ps1: -------------------------------------------------------------------------------- 1 | $pythonPath = "C:\scoop\apps\kicad\current\bin" 2 | 3 | Write-Output "Remove all Python paths from environment" 4 | $arrPath = $env:Path -split ";" | Where-Object {$_ -notMatch "Python"} 5 | 6 | Write-Output "Add KiCad's python to environment" 7 | $addPaths = $pythonPath,"$pythonPath\Scripts" 8 | $env:Path = ($arrPath + $addPaths) -join ";" 9 | 10 | python -c "import pcbnew; print('KiCad version: ' + pcbnew.Version())" 11 | 12 | if ($LastExitCode -ne 0) { 13 | Write-Error "Could not import pcbnew" 14 | } 15 | 16 | Write-Output "Creating symbolic link for python3" 17 | New-Item -Path "$pythonPath\python3.exe" ` 18 | -ItemType SymbolicLink ` 19 | -Value "$pythonPath\python.exe" ` 20 | -Force | Out-Null 21 | 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .env/ 2 | __pycache__/ 3 | source/kicadgit.log 4 | source/version.txt 5 | dist/ 6 | *.egg-info/ 7 | .mypy_cache/ 8 | .coverage 9 | -------------------------------------------------------------------------------- /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 | # kicad-git 2 | 3 | [![KiCad Repository](https://img.shields.io/badge/KiCad-Plugin%20Repository-blue)](https://gitlab.com/kicad/addons/metadata/-/tree/main/packages/com.github.adamws.kicad-git) 4 | ![GitHub all releases](https://img.shields.io/github/downloads/adamws/kicad-git/total) 5 | [![CircleCI](https://circleci.com/gh/adamws/kicad-git.svg?style=shield)](https://circleci.com/gh/adamws/kicad-git/tree/master) 6 | [![Coverage Status](https://coveralls.io/repos/github/adamws/kicad-git/badge.svg?branch=master)](https://coveralls.io/github/adamws/kicad-git?branch=master) 7 | 8 | KiCad plugin for git integration. Launch git commit graphical interface without leaving PCB editor window. 9 | 10 | ## Installation 11 | 12 | To install release version of this plugin, use KiCad's `Plugin and Content Manager` 13 | and select `Git plugin` from official plugin repository. 14 | 15 | ![pcm-image](resources/pcm.png) 16 | 17 | Latest `master` build is automatically uploaded to unofficial PCM compatible 18 | [repository](https://adamws.github.io/kicad-git/) hosted on GitHub pages. 19 | To use it, add `https://adamws.github.io/kicad-git/repository.json` 20 | to PCM repository list. 21 | 22 | > [!WARNING] 23 | > By default, this plugin uses [`git gui`](https://git-scm.com/docs/git-gui). 24 | > On most systems it is distributed as part of the git suite. 25 | > On macOS it might be required to install it separately with `brew install git-gui` 26 | 27 | ## How to use? 28 | 29 | - Click plugin button to open commit window 30 | 31 | ![toolbar-image](resources/toolbar.png) 32 | 33 | ![how-to-commit](resources/how-to-commit.png) 34 | 35 | > [!IMPORTANT] 36 | > Plugin button appears only in PCB editor and not in schematic editor. This is KiCad limitation. 37 | 38 | ### Configuration 39 | 40 | To configure different command for starting git GUI or explicitly define git executable path, 41 | create `config.ini` file in the plugin directory. 42 | 43 | For example, to use [TortoiseGit](https://tortoisegit.org) and non standard (not in system search `PATH`) git executable: 44 | 45 | ```ini 46 | [paths] 47 | git = C:\some\path\git.exe 48 | git_gui = TortoiseGitProc.exe /command:commit 49 | ``` 50 | 51 | > [!WARNING] 52 | > The `[paths]` section in config file is required and can't be skipped. 53 | 54 | By default, this plugin starts `git gui` window which will remain open after clicking 'commit' 55 | button. To start window for arranging and making exactly one commit use `git citool` instead: 56 | 57 | ```ini 58 | [paths] 59 | git = C:\some\path\git.exe 60 | git_gui = C:\some\path\git.exe citool 61 | ``` 62 | 63 | > [!WARNING] 64 | > The `citool` is limited only to commits, `push` to remote is not supported from this view. 65 | > See [git manual page](https://www.man7.org/linux/man-pages/man1/git-gui.1.html#top_of_page) to learn more. 66 | 67 | ### See also 68 | 69 | :link: [PCB visual diff with kicad-cli and lukaj](https://adamws.github.io/pcb-visual-diff-with-kicad-cli-and-lukaj) 70 | -------------------------------------------------------------------------------- /dev-requirements.txt: -------------------------------------------------------------------------------- 1 | black==23.1.0 2 | dulwich==0.20.15 3 | pytest==8.1.1 4 | pytest-cov==5.0.0 5 | -------------------------------------------------------------------------------- /metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://go.kicad.org/pcm/schemas/v1", 3 | "name": "Git Plugin", 4 | "description": "Git integration for KiCad", 5 | "description_full": "Git integration for KiCad", 6 | "identifier": "com.github.adamws.kicad-git", 7 | "type": "plugin", 8 | "author": { 9 | "name": "Adam Wysocki (adamws)", 10 | "contact": { 11 | "web": "https://adamws.github.io/" 12 | } 13 | }, 14 | "license": "GPL-3.0", 15 | "resources": { 16 | "homepage": "https://github.com/adamws/kicad-git" 17 | }, 18 | "versions": [ 19 | { 20 | "version": "0.1", 21 | "status": "development", 22 | "kicad_version": "7.0" 23 | } 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = [ 3 | "hatchling>=1.18", 4 | "hatch-kicad", 5 | "hatch-vcs", 6 | ] 7 | build-backend = "hatchling.build" 8 | 9 | [project] 10 | name = "kicad-git" 11 | authors = [ 12 | { name = "adamws", email = "adamws@users.noreply.github.com" }, 13 | ] 14 | description = "KiCad plugin for git" 15 | keywords = ["kicad"] 16 | requires-python = ">=3.8" 17 | license = {text = "GPL-3.0"} 18 | classifiers = [ 19 | "Development Status :: 2 - Pre-Alpha", 20 | "Intended Audience :: Manufacturing", 21 | "Operating System :: OS Independent", 22 | "Programming Language :: Python :: 3", 23 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 24 | "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)" 25 | ] 26 | dynamic = ["version"] 27 | 28 | [project.urls] 29 | "Homepage" = "https://github.com/adamws/kicad-git" 30 | "Bug Tracker" = "https://github.com/adamws/kicad-git/issues" 31 | "Sponsor" = "https://ko-fi.com/adamws" 32 | 33 | [tool.hatch] 34 | build.targets.sdist.include = [ 35 | "source/*.py" 36 | ] 37 | 38 | [tool.hatch.version] 39 | source = "vcs" 40 | 41 | [tool.hatch.build.hooks.vcs] 42 | version-file = "source/version.txt" 43 | 44 | [tool.hatch.build.targets.kicad-package] 45 | name = "Git plugin" 46 | description = "KiCad plugin for git" 47 | description_full = [ 48 | "Git actions directly from KiCad's PCB editor window", 49 | ] 50 | identifier = "com.github.adamws.kicad-git" 51 | author = { name = "adamws", web="https://adamws.github.io" } 52 | status = "{env:PLUGIN_KICAD_STATUS:development}" 53 | kicad_version = "7.0" 54 | sources = ["source"] # rewrite paths 55 | include = [ 56 | "source/*.py", 57 | "source/version.txt", 58 | "source/icon.png", 59 | ] 60 | icon = "resources/icon.png" 61 | download_url = "{env:PLUGIN_KICAD_RELEASE_URL:https://adamws.github.io/kicad-git/{zip_name}}" 62 | 63 | [tool.hatch.build.targets.kicad-package.hooks.kicad-repository] 64 | enable-by-default = false 65 | 66 | [tool.hatch.envs.lint] 67 | detached = true 68 | dependencies = [ 69 | "black>=23.1.0", 70 | "mypy>=1.0.0", 71 | "ruff>=0.0.243", 72 | ] 73 | [tool.hatch.envs.lint.scripts] 74 | typing = "mypy --install-types --non-interactive --cache-dir=.mypy_cache {args:source tests}" 75 | style = [ 76 | "ruff check {args:.}", 77 | "black --check --output-format=concise {args:.}", 78 | ] 79 | fmt = [ 80 | "black {args:.}", 81 | "ruff check --fix --output-format=concise {args:.}", 82 | "style", 83 | ] 84 | all = [ 85 | "style", 86 | "typing", 87 | ] 88 | 89 | [tool.black] 90 | target-version = ["py37"] 91 | line-length = 88 92 | 93 | [tool.ruff] 94 | lint.select = ["ANN", "E", "F", "I", "N", "PL", "W"] 95 | lint.ignore = ["ANN101"] 96 | 97 | [tool.ruff.lint.per-file-ignores] 98 | "source/git_plugin_action.py" = ["N802"] 99 | 100 | [tool.ruff.lint.isort] 101 | known-first-party = ["hatch_kicad"] 102 | 103 | [tool.ruff.lint.flake8-tidy-imports] 104 | ban-relative-imports = "all" 105 | 106 | [tool.coverage.run] 107 | relative_files = true 108 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | addopts = --cov=source 3 | log_cli = True 4 | log_cli_level = DEBUG 5 | log_cli_format = %(asctime)s [%(levelname)8s] %(message)s 6 | log_cli_date_format = %H:%M:%S 7 | -------------------------------------------------------------------------------- /release/deploy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -o nounset 4 | set -o errexit 5 | 6 | CUR_DIR="$(dirname $(readlink -f "$0"))" 7 | cd ${CUR_DIR}/../dist/repository 8 | 9 | echo "==> Prepare to deploy\n" 10 | git init 11 | git config --global user.name "CircleCI" 12 | git config --global user.email "${CIRCLE_PROJECT_USERNAME}@users.noreply.github.com" 13 | 14 | if [ -z "$(git status --porcelain)" ]; then 15 | echo "Something went wrong" && \ 16 | echo "Exiting..." 17 | exit 0 18 | fi 19 | 20 | mkdir .circleci 21 | wget https://raw.githubusercontent.com/adamws/kicad-git/master/.circleci/ghpages-config.yml -O .circleci/config.yml 22 | touch .nojekyll 23 | 24 | echo "==> Start deploying" 25 | git add -A 26 | git commit -m "Deploy plugin repository: ${CIRCLE_SHA1}" 27 | 28 | git push --force $CIRCLE_REPOSITORY_URL master:gh-pages 29 | 30 | rm -fr .git 31 | 32 | echo "==> Deploy succeeded" 33 | -------------------------------------------------------------------------------- /resources/how-to-commit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/resources/how-to-commit.png -------------------------------------------------------------------------------- /resources/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/resources/icon.png -------------------------------------------------------------------------------- /resources/pcm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/resources/pcm.png -------------------------------------------------------------------------------- /resources/toolbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/resources/toolbar.png -------------------------------------------------------------------------------- /source/__init__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | if sys.argv[0] != "-m" and not sys.argv[0].endswith("pytest"): 4 | from .git_plugin_action import GitPluginAction 5 | 6 | GitPluginAction().register() 7 | -------------------------------------------------------------------------------- /source/git.py: -------------------------------------------------------------------------------- 1 | import configparser 2 | import os 3 | import platform 4 | import shlex 5 | import subprocess 6 | import sys 7 | from pathlib import Path 8 | from typing import Optional 9 | 10 | if platform.system() == "Darwin": 11 | DEFAULT_CONFIG = """[paths] 12 | git = /opt/homebrew/bin/git 13 | git_gui = /opt/homebrew/bin/git gui""" 14 | else: 15 | DEFAULT_CONFIG = """[paths] 16 | git = git 17 | git_gui = git gui""" 18 | 19 | config = configparser.ConfigParser() 20 | config.read_string(DEFAULT_CONFIG) 21 | config.read(os.path.dirname(__file__) + "/config.ini") 22 | 23 | git: str = config["paths"]["git"] 24 | git_gui: str = config["paths"]["git_gui"] 25 | 26 | 27 | def __run(command: str, cwd: Path) -> str: 28 | args = f"{git} {command}" 29 | if sys.platform != "win32": 30 | args = shlex.split(args) 31 | process = subprocess.Popen( 32 | args, 33 | cwd=cwd, 34 | stdout=subprocess.PIPE, 35 | stderr=subprocess.STDOUT, 36 | universal_newlines=True, 37 | ) 38 | process.wait() 39 | output = "" 40 | if process.stdout: 41 | output = process.stdout.read() 42 | if process.returncode == 0: 43 | return output 44 | error = f"Error: Failed to '{git} {command}', received: {output}" 45 | raise RuntimeError(error) 46 | 47 | 48 | def version() -> str: 49 | return __run("version", Path(".")) 50 | 51 | 52 | def toplevel(path: Path) -> Optional[Path]: 53 | if path.exists(): 54 | try: 55 | result = __run("rev-parse --show-toplevel", path).strip() 56 | if result: 57 | return Path(result) 58 | except RuntimeError: 59 | pass 60 | return None 61 | 62 | 63 | def guitool(repo_dir: Path) -> None: 64 | args = git_gui 65 | if sys.platform != "win32": 66 | args = shlex.split(args) 67 | subprocess.Popen(args, cwd=repo_dir) 68 | 69 | 70 | __all__ = ["version", "toplevel", "guitool"] 71 | -------------------------------------------------------------------------------- /source/git_plugin_action.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import sys 4 | from pathlib import Path 5 | from typing import Tuple 6 | 7 | import pcbnew 8 | import wx 9 | 10 | from . import git 11 | 12 | logger = logging.getLogger(__name__) 13 | 14 | 15 | class PluginError(Exception): 16 | def __init__(self, message: str) -> None: 17 | self.message = message 18 | super().__init__(self.message) 19 | 20 | 21 | def setup_logging(destination: str) -> None: 22 | # Remove all handlers associated with the root logger object. 23 | for handler in logging.root.handlers[:]: 24 | logging.root.removeHandler(handler) 25 | 26 | # set up logger 27 | logging.basicConfig( 28 | level=logging.DEBUG, 29 | filename=f"{destination}/kicadgit.log", 30 | filemode="w", 31 | format="%(asctime)s %(name)s %(lineno)d: %(message)s", 32 | datefmt="%H:%M:%S", 33 | ) 34 | 35 | 36 | def get_kicad_version() -> str: 37 | version = pcbnew.Version() 38 | if int(version.split(".")[0]) < 7: 39 | msg = f"KiCad version {version} is not supported" 40 | raise PluginError(msg) 41 | logger.info(f"Plugin executed with KiCad version: {version}") 42 | logger.info(f"Plugin executed with python version: {repr(sys.version)}") 43 | return version 44 | 45 | 46 | def get_git_version() -> str: 47 | try: 48 | git_version = git.version() 49 | if not git_version.startswith("git version "): 50 | msg = f"Unexpected git version: {git_version}" 51 | raise PluginError(msg) 52 | except Exception as e: 53 | msg = f"Could not find git executable: {e}" 54 | raise PluginError(msg) 55 | logger.info(f"Plugin executed with {git_version}") 56 | return git_version 57 | 58 | 59 | def get_board() -> Tuple[pcbnew.BOARD, str]: 60 | board = pcbnew.GetBoard() 61 | if not board: 62 | msg = "Could not load board" 63 | raise PluginError(msg) 64 | board_file = board.GetFileName() 65 | if not board_file: 66 | msg = "Could not locate .kicad_pcb file, open or create it first" 67 | raise PluginError(msg) 68 | logger.info(f"Board file: {board_file}") 69 | return board, board_file 70 | 71 | 72 | def get_repo_dir(board_file: str) -> Path: 73 | board_dir = Path(board_file).parent 74 | repo_dir = git.toplevel(board_dir) 75 | if repo_dir is None: 76 | msg = "Could not locate git repository" 77 | raise PluginError(msg) 78 | logger.info(f"Repository top directory: {repo_dir}") 79 | return repo_dir 80 | 81 | 82 | class GitPluginAction(pcbnew.ActionPlugin): 83 | def defaults(self) -> None: 84 | self.name = "Git Plugin" 85 | self.category = "" 86 | self.description = "" 87 | self.show_toolbar_button = True 88 | self.icon_file_name = os.path.join(os.path.dirname(__file__), "icon.png") 89 | 90 | def Initialize(self) -> None: 91 | self.window = wx.GetActiveWindow() 92 | self.plugin_path = os.path.dirname(__file__) 93 | setup_logging(self.plugin_path) 94 | 95 | _ = get_kicad_version() 96 | _ = get_git_version() 97 | 98 | self.board, self.board_file = get_board() 99 | self.repo_dir = get_repo_dir(self.board_file) 100 | 101 | def Run(self) -> None: 102 | try: 103 | self.Initialize() 104 | self.board.Save(self.board_file) 105 | git.guitool(self.repo_dir) 106 | except PluginError as e: 107 | error = wx.MessageDialog(self.window, e.message, style=wx.ICON_ERROR) 108 | error.ShowModal() 109 | 110 | logging.shutdown() 111 | -------------------------------------------------------------------------------- /source/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/source/icon.png -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adamws/kicad-git/d81ee48473a9bc25c9cc1183fb71bccf72e6ba6a/tests/__init__.py -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | import pytest 4 | from dulwich.repo import Repo 5 | 6 | 7 | @pytest.fixture() 8 | def repo(tmpdir: Path) -> Repo: 9 | repo = Repo.init(tmpdir) 10 | config = repo.get_config() 11 | config.set("user", "email", "test@pytest") 12 | config.set("user", "name", "pytest") 13 | config.write_to_path() 14 | return repo 15 | -------------------------------------------------------------------------------- /tests/test_git.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | from dulwich.repo import Repo 4 | 5 | import source.git as g 6 | 7 | 8 | def test_get_version() -> None: 9 | assert g.version().startswith("git version ") 10 | 11 | 12 | def test_toplevel_in_repo(repo: Repo) -> None: 13 | assert repo.path == g.toplevel(repo.path) 14 | 15 | 16 | def test_toplevel_in_repo_child_dir(repo: Repo) -> None: 17 | child = repo.path.mkdir("child") 18 | assert repo.path == g.toplevel(child) 19 | 20 | 21 | def test_toplevel_not_in_repo(tmpdir: Path) -> None: 22 | assert None is g.toplevel(tmpdir) 23 | 24 | 25 | def test_toplevel_non_exsisting_path(tmpdir: Path) -> None: 26 | assert None is g.toplevel(tmpdir / "not_created_repo") 27 | -------------------------------------------------------------------------------- /tests/test_plugin.py: -------------------------------------------------------------------------------- 1 | import os 2 | from pathlib import Path 3 | from unittest.mock import MagicMock, patch 4 | 5 | import pcbnew 6 | import pytest 7 | import wx 8 | from dulwich.repo import Repo 9 | 10 | from source.git_plugin_action import ( 11 | GitPluginAction, 12 | get_board, 13 | get_git_version, 14 | get_kicad_version, 15 | get_repo_dir, 16 | setup_logging, 17 | ) 18 | 19 | 20 | def test_if_plugin_loads() -> None: 21 | dirname = Path(os.path.realpath(__file__)).parents[1] 22 | pcbnew.LoadPluginModule(dirname, "source", "") 23 | not_loaded = pcbnew.GetUnLoadableWizards() 24 | assert not_loaded == "", pcbnew.GetWizardsBackTrace() 25 | 26 | 27 | def test_setup_logging(tmpdir: Path) -> None: 28 | setup_logging(str(tmpdir)) 29 | assert Path(f"{tmpdir}/kicadgit.log").exists() 30 | 31 | 32 | def test_get_kicad_version() -> None: 33 | assert get_kicad_version()[0] in ["7", "8"] 34 | 35 | 36 | @patch("pcbnew.Version") 37 | def test_get_kicad_version_unsupported(mock_pcbnew_version: MagicMock) -> None: 38 | mock_pcbnew_version.return_value = "6.0.11" 39 | with pytest.raises(Exception, match="KiCad version 6.0.11 is not supported"): 40 | get_kicad_version() 41 | 42 | 43 | def test_git_version() -> None: 44 | assert get_git_version().startswith("git version ") 45 | 46 | 47 | @patch("source.git.version", side_effect=Exception("Mocked exception")) 48 | def test_git_version_executable_missing(mock_git_version: MagicMock) -> None: 49 | _ = mock_git_version 50 | with pytest.raises( 51 | Exception, match="Could not find git executable: Mocked exception" 52 | ): 53 | get_git_version() 54 | 55 | 56 | @patch("source.git.version") 57 | def test_git_version_unexpected_value(mock_git_version: MagicMock) -> None: 58 | mock_git_version.return_value = "git: 'xxx' is not a git command" 59 | with pytest.raises( 60 | Exception, 61 | match="Could not find git executable: " 62 | f"Unexpected git version: {mock_git_version.return_value}", 63 | ): 64 | get_git_version() 65 | 66 | 67 | @patch("pcbnew.GetBoard") 68 | def test_get_board(mock_get_board: MagicMock) -> None: 69 | mock_board = MagicMock() 70 | mock_get_board.return_value = mock_board 71 | mock_board.GetFileName.return_value = "test_board.kicad_pcb" 72 | 73 | result_board, result_board_file = get_board() 74 | 75 | assert result_board == mock_board 76 | assert result_board_file == "test_board.kicad_pcb" 77 | 78 | 79 | @patch("pcbnew.GetBoard", return_value=None) 80 | def test_get_board_no_board(mock_get_board: MagicMock) -> None: 81 | _ = mock_get_board 82 | with pytest.raises(Exception, match="Could not load board"): 83 | get_board() 84 | 85 | 86 | @patch("pcbnew.GetBoard") 87 | def test_get_board_no_board_file(mock_get_board: MagicMock) -> None: 88 | mock_board = MagicMock() 89 | mock_get_board.return_value = mock_board 90 | mock_board.GetFileName.return_value = None 91 | 92 | with pytest.raises( 93 | Exception, match="Could not locate .kicad_pcb file, open or create it first" 94 | ): 95 | get_board() 96 | 97 | 98 | def test_get_repo_dir(repo: Repo) -> None: 99 | board = f"{repo.path}/fake.kicad_pcb" 100 | assert get_repo_dir(board) == repo.path 101 | 102 | 103 | def test_get_repo_dir_exception(tmpdir: Path) -> None: 104 | with pytest.raises(Exception, match="Could not locate git repository"): 105 | get_repo_dir(f"{tmpdir}/fake.kicad_pcb") 106 | 107 | 108 | @patch("wx.GetActiveWindow") 109 | @patch("source.git_plugin_action.setup_logging") 110 | @patch("source.git_plugin_action.get_kicad_version", return_value="KiCad 7.0.0") 111 | @patch("source.git_plugin_action.get_git_version", return_value="git version 2.0.0") 112 | @patch( 113 | "source.git_plugin_action.get_board", 114 | return_value=(MagicMock(), "test_board.kicad_pcb"), 115 | ) 116 | @patch("source.git_plugin_action.get_repo_dir", return_value="/path/to/repo") 117 | @patch("source.git.guitool") 118 | def test_run_success( 119 | mock_guitool: MagicMock, 120 | mock_get_repo_dir: MagicMock, 121 | mock_get_board: MagicMock, 122 | mock_get_git_version: MagicMock, 123 | mock_get_kicad_version: MagicMock, 124 | mock_setup_logging: MagicMock, 125 | mock_get_active_window: MagicMock, 126 | ) -> None: 127 | action = GitPluginAction() 128 | 129 | with patch.object( 130 | wx, "MessageDialog", side_effect=wx.MessageDialog 131 | ) as mock_message_dialog: 132 | action.Run() 133 | 134 | mock_get_active_window.assert_called_once() 135 | mock_setup_logging.assert_called_once() 136 | mock_get_kicad_version.assert_called_once() 137 | mock_get_git_version.assert_called_once() 138 | mock_get_board.assert_called_once() 139 | mock_get_repo_dir.assert_called_once() 140 | mock_guitool.assert_called_once_with("/path/to/repo") 141 | mock_message_dialog.assert_not_called() 142 | --------------------------------------------------------------------------------