From d9dd9b2b53d4c4c64fa56a5499d45d710f66f9de Mon Sep 17 00:00:00 2001 From: "Morgan 'ARR\\!' Allen" Date: Fri, 28 Mar 2025 23:09:29 -0700 Subject: [PATCH] boilerplate, build/config, legal, not sure what all is even needed --- CMakeLists.txt | 37 +++++++++++ LICENSE | 166 +++++++++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 1 + pyproject.toml | 32 ++++++++++ setup.py | 17 +++++ 5 files changed, 253 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 pyproject.toml create mode 100644 setup.py diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..91d7f8d --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,37 @@ +set(Namespace_SRCS + freecad/kiconnect/init_gui.py + freecad/kiconnect/__init__.py + freecad/kiconnect/version.py + freecad/kiconnect/resources/translations/kiconnect_es-ES.ts + freecad/kiconnect/commands/cmd_sync_to.py + freecad/kiconnect/commands/cmd_new_pcb.py + freecad/kiconnect/commands/cmd_sync_from.py + freecad/kiconnect/commands/__init__.py + freecad/kiconnect/commands/cmd_reload.py + freecad/kiconnect/board.py + freecad/kiconnect/api.py + freecad/kiconnect/version.py + freecad/kiconnect/parts.py + freecad/kiconnect/project.py + freecad/kiconnect/init.py + freecad/kiconnect/copper.py + freecad/kiconnect/settings.py + freecad/kiconnect/bases/BaseObject.py + freecad/kiconnect/bases/BaseViewProvider.py + freecad/kiconnect/bases/__init__.py +) + +SOURCE_GROUP("" FILES ${Namespace_SRCS}) + +ADD_CUSTOM_TARGET(SEARCHBAR ALL + SOURCES ${Namespace_SRCS} +) + +fc_copy_sources(SEARCHBAR "${CMAKE_BINARY_DIR}/Mod/KiConnect" ${Namespace_SRCS}) + +INSTALL( + FILES + ${Namespace_SRCS} + DESTINATION + Mod/SearchBar +) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5357f69 --- /dev/null +++ b/LICENSE @@ -0,0 +1,166 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..806142e --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +recursive-include kiconnect/resources * diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a78f2aa --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,32 @@ +# References: +# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/ +# https://packaging.python.org/en/latest/guides/packaging-namespace-packages/#native-namespace-packages +# https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ +# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name = "freecad.kiconnect" +dynamic = ["version"] +description = "Printed Circuit Workbench for interacting with KiCAD v9+ API" +readme = "README.md" +license = {file = "LICENSE"} +maintainers = [ + {name = "morgan", email = "morgan@oit.cloud" + }, +] +requires-python = ">=3.8" +dependencies = ["'numpy',"] + +[project.urls] +source = "https://git.oit.cloud/morgan/kiconnect" + +[tool.setuptools] +packages = ["freecad", "freecad.kiconnect"] +include-package-data = true + +[tool.setuptools.dynamic] +version = {attr = "kiconnect.__version__"} diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..0cd738d --- /dev/null +++ b/setup.py @@ -0,0 +1,17 @@ +from setuptools import setup +import os + +version_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'freecad', 'kiconnect', 'version.py') +with open(version_path) as fp: + exec(fp.read()) + +print(__version__) +setup(name='freecad.kiconnect', + version=str(__version__), + packages=['freecad.kiconnect'], + maintainer='morgan', + maintainer_email='morgan@oit.cloud', + url='https://git.oit.cloud/morgan/kiconnect', + description='Printed Circuit Workbench for interacting with KiCAD v9+ API', + install_requires=['git+https://gitlab.com/kicad/code/kicad-python.git@55feccb010d3c3d5e501133b87330bbdafef5fff',], + include_package_data=True)