diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-kicad-helpers.spec | 477 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 479 insertions, 0 deletions
@@ -0,0 +1 @@ +/kicad_helpers-0.14.tar.gz diff --git a/python-kicad-helpers.spec b/python-kicad-helpers.spec new file mode 100644 index 0000000..66d9e8c --- /dev/null +++ b/python-kicad-helpers.spec @@ -0,0 +1,477 @@ +%global _empty_manifest_terminate_build 0 +Name: python-kicad-helpers +Version: 0.14 +Release: 1 +Summary: Scripts, templates, and examples for managing KiCad projects. +License: BSD License +URL: https://github.com/ryanfobel/kicad-helpers/tree/main/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/4b/89/2d99511cba11238e6ea238daf8c92df94ef56e8aae7a2ad9194bb03e2c1f/kicad_helpers-0.14.tar.gz +BuildArch: noarch + +Requires: python3-fastcore +Requires: python3-nbformat +Requires: python3-nbconvert +Requires: python3-pyyaml +Requires: python3-jupyter-client +Requires: python3-jupyter +Requires: python3-ipykernel +Requires: python3-ghapi +Requires: python3-fastrelease +Requires: python3-gitpython +Requires: python3-pandas +Requires: python3-dotenv +Requires: python3-nbdev +Requires: python3-pandera +Requires: python3-kifield + +%description +# Welcome to kicad-helpers +> Scripts, templates, and examples for managing KiCad projects + + +[](https://github.com/ryanfobel/kicad-helpers/actions/workflows/python-package.yml) +[](https://pypi.python.org/pypi/kicad-helpers/) + +## Project goals + +* provide a sensible default structure and scripts for managing KiCad projects +* automate everything that can be automated with continuous integrations scripts (e.g., [update BOMs][update BOMs], produce manufacturing files, [run tests][run tests], generate documentation, etc.) +* configure git and KiCad to play nicely together +* support customization via command line arguments, environment variables, etc. +* make everything easy to install/setup/use +* make [awesome documentation](https://ryanfobel.github.io/kicad-helpers/) + +[update BOMs]: https://ryanfobel.github.io/kicad-helpers/#Export-a-BOM-from-the-KiCad-schematic +[run tests]: https://ryanfobel.github.io/kicad-helpers/#Run-all-tests-in-the-tests-directory + +## Install + +```sh +> pip install kicad_helpers +``` + +## Setup a new project + +Open a command line shell and navigate to the directory containing your KiCad project. Then run `kh_update` to apply various project templates to the project directory: + +```sh +> cd kicad/project/path +> kh_update +``` + +By default, this will install the following templates: +* [.github/workflows/build.yml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.github/workflows/build.yml): a github workflow for updating the BOM, producing manufacturing files, running tests, generating documentation, etc. +* [kitspace.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/kitspace.yaml): metadata file for the [kitspace](https://kitspace.org/) service +* [.kicad_helpers_config/config.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/config.kibot.yaml): configuration file for [KiBot](https://github.com/INTI-CMNB/KiBot) which allow automation of various KiCad actions +* [.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml): [KiBot](https://github.com/INTI-CMNB/KiBot) configuration to generate manufacturing files for [PCBWay](https://www.pcbway.com/) + + +To overwrite existing templates, run `kh_update` with the `--overwrite` flag: + +```sh +> kh_update --v --overwrite +``` + + Render kitspace.yaml template. + Render settings.ini template. + Render .github/workflows/build.yml template. + Render .kicad_helpers_config/drc.yaml template. + Render .kicad_helpers_config/erc.yaml template. + Render .kicad_helpers_config/pcb_pdf.yaml template. + Render .kicad_helpers_config/pcb_svg.yaml template. + Render .kicad_helpers_config/sch_pdf.yaml template. + Render .kicad_helpers_config/sch_svg.yaml template. + Render .kicad_helpers_config/manufacturers/default.yaml template. + Render .kicad_helpers_config/manufacturers/PCBWay.yaml template. + Render tests/Tests.ipynb template. + "*.pro filter=kicad_project" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + "*.sch filter=kicad_sch" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + Add filters to git config. + "_autosave*" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*bak" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*.xml" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + ".ipynb_checkpoints" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-erc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-drc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "kibot_errors.filter" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + + + +To see the options that are available, run the command: + +```sh +> kh_update --help +``` + + usage: kh_update [-h] [--v] [--overwrite] [--root ROOT] + + Setup a new project (or update an existing project) with templates from the `kicad_helpers/templates` directory. Also + installs git filters to prevent insignificant changes to the kicad `*.pro` and `*.sch` files from being tracked by git + (see https://jnavila.github.io/plotkicadsch/ for more details). + + optional arguments: + -h, --help show this help message and exit + --v verbose (default: False) + --overwrite overwrite existing templates (default: False) + --root ROOT project root directory (default: .) + + + +## Export a BOM from the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --group -aq -x /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch -i /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv + + + + +## Import data from the BOM into the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --fields ~quantity -x /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv -i /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch + + + + +## Run all tests in the `tests` directory + +```sh +> kh_test +``` + + testing /home/ryan/dev/python/kicad-helpers/_temp/tests/Tests.ipynb + All tests are passing! + + + +## Contributors + +* Ryan Fobel ([@ryanfobel](https://github.com/ryanfobel)) + + + + +%package -n python3-kicad-helpers +Summary: Scripts, templates, and examples for managing KiCad projects. +Provides: python-kicad-helpers +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-kicad-helpers +# Welcome to kicad-helpers +> Scripts, templates, and examples for managing KiCad projects + + +[](https://github.com/ryanfobel/kicad-helpers/actions/workflows/python-package.yml) +[](https://pypi.python.org/pypi/kicad-helpers/) + +## Project goals + +* provide a sensible default structure and scripts for managing KiCad projects +* automate everything that can be automated with continuous integrations scripts (e.g., [update BOMs][update BOMs], produce manufacturing files, [run tests][run tests], generate documentation, etc.) +* configure git and KiCad to play nicely together +* support customization via command line arguments, environment variables, etc. +* make everything easy to install/setup/use +* make [awesome documentation](https://ryanfobel.github.io/kicad-helpers/) + +[update BOMs]: https://ryanfobel.github.io/kicad-helpers/#Export-a-BOM-from-the-KiCad-schematic +[run tests]: https://ryanfobel.github.io/kicad-helpers/#Run-all-tests-in-the-tests-directory + +## Install + +```sh +> pip install kicad_helpers +``` + +## Setup a new project + +Open a command line shell and navigate to the directory containing your KiCad project. Then run `kh_update` to apply various project templates to the project directory: + +```sh +> cd kicad/project/path +> kh_update +``` + +By default, this will install the following templates: +* [.github/workflows/build.yml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.github/workflows/build.yml): a github workflow for updating the BOM, producing manufacturing files, running tests, generating documentation, etc. +* [kitspace.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/kitspace.yaml): metadata file for the [kitspace](https://kitspace.org/) service +* [.kicad_helpers_config/config.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/config.kibot.yaml): configuration file for [KiBot](https://github.com/INTI-CMNB/KiBot) which allow automation of various KiCad actions +* [.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml): [KiBot](https://github.com/INTI-CMNB/KiBot) configuration to generate manufacturing files for [PCBWay](https://www.pcbway.com/) + + +To overwrite existing templates, run `kh_update` with the `--overwrite` flag: + +```sh +> kh_update --v --overwrite +``` + + Render kitspace.yaml template. + Render settings.ini template. + Render .github/workflows/build.yml template. + Render .kicad_helpers_config/drc.yaml template. + Render .kicad_helpers_config/erc.yaml template. + Render .kicad_helpers_config/pcb_pdf.yaml template. + Render .kicad_helpers_config/pcb_svg.yaml template. + Render .kicad_helpers_config/sch_pdf.yaml template. + Render .kicad_helpers_config/sch_svg.yaml template. + Render .kicad_helpers_config/manufacturers/default.yaml template. + Render .kicad_helpers_config/manufacturers/PCBWay.yaml template. + Render tests/Tests.ipynb template. + "*.pro filter=kicad_project" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + "*.sch filter=kicad_sch" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + Add filters to git config. + "_autosave*" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*bak" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*.xml" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + ".ipynb_checkpoints" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-erc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-drc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "kibot_errors.filter" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + + + +To see the options that are available, run the command: + +```sh +> kh_update --help +``` + + usage: kh_update [-h] [--v] [--overwrite] [--root ROOT] + + Setup a new project (or update an existing project) with templates from the `kicad_helpers/templates` directory. Also + installs git filters to prevent insignificant changes to the kicad `*.pro` and `*.sch` files from being tracked by git + (see https://jnavila.github.io/plotkicadsch/ for more details). + + optional arguments: + -h, --help show this help message and exit + --v verbose (default: False) + --overwrite overwrite existing templates (default: False) + --root ROOT project root directory (default: .) + + + +## Export a BOM from the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --group -aq -x /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch -i /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv + + + + +## Import data from the BOM into the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --fields ~quantity -x /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv -i /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch + + + + +## Run all tests in the `tests` directory + +```sh +> kh_test +``` + + testing /home/ryan/dev/python/kicad-helpers/_temp/tests/Tests.ipynb + All tests are passing! + + + +## Contributors + +* Ryan Fobel ([@ryanfobel](https://github.com/ryanfobel)) + + + + +%package help +Summary: Development documents and examples for kicad-helpers +Provides: python3-kicad-helpers-doc +%description help +# Welcome to kicad-helpers +> Scripts, templates, and examples for managing KiCad projects + + +[](https://github.com/ryanfobel/kicad-helpers/actions/workflows/python-package.yml) +[](https://pypi.python.org/pypi/kicad-helpers/) + +## Project goals + +* provide a sensible default structure and scripts for managing KiCad projects +* automate everything that can be automated with continuous integrations scripts (e.g., [update BOMs][update BOMs], produce manufacturing files, [run tests][run tests], generate documentation, etc.) +* configure git and KiCad to play nicely together +* support customization via command line arguments, environment variables, etc. +* make everything easy to install/setup/use +* make [awesome documentation](https://ryanfobel.github.io/kicad-helpers/) + +[update BOMs]: https://ryanfobel.github.io/kicad-helpers/#Export-a-BOM-from-the-KiCad-schematic +[run tests]: https://ryanfobel.github.io/kicad-helpers/#Run-all-tests-in-the-tests-directory + +## Install + +```sh +> pip install kicad_helpers +``` + +## Setup a new project + +Open a command line shell and navigate to the directory containing your KiCad project. Then run `kh_update` to apply various project templates to the project directory: + +```sh +> cd kicad/project/path +> kh_update +``` + +By default, this will install the following templates: +* [.github/workflows/build.yml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.github/workflows/build.yml): a github workflow for updating the BOM, producing manufacturing files, running tests, generating documentation, etc. +* [kitspace.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/kitspace.yaml): metadata file for the [kitspace](https://kitspace.org/) service +* [.kicad_helpers_config/config.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/config.kibot.yaml): configuration file for [KiBot](https://github.com/INTI-CMNB/KiBot) which allow automation of various KiCad actions +* [.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml](https://github.com/ryanfobel/kicad-helpers/blob/main/kicad_helpers/templates/.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml): [KiBot](https://github.com/INTI-CMNB/KiBot) configuration to generate manufacturing files for [PCBWay](https://www.pcbway.com/) + + +To overwrite existing templates, run `kh_update` with the `--overwrite` flag: + +```sh +> kh_update --v --overwrite +``` + + Render kitspace.yaml template. + Render settings.ini template. + Render .github/workflows/build.yml template. + Render .kicad_helpers_config/drc.yaml template. + Render .kicad_helpers_config/erc.yaml template. + Render .kicad_helpers_config/pcb_pdf.yaml template. + Render .kicad_helpers_config/pcb_svg.yaml template. + Render .kicad_helpers_config/sch_pdf.yaml template. + Render .kicad_helpers_config/sch_svg.yaml template. + Render .kicad_helpers_config/manufacturers/default.yaml template. + Render .kicad_helpers_config/manufacturers/PCBWay.yaml template. + Render tests/Tests.ipynb template. + "*.pro filter=kicad_project" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + "*.sch filter=kicad_sch" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitattributes + Add filters to git config. + "_autosave*" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*bak" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*.xml" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + ".ipynb_checkpoints" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-erc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "*-drc.txt" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + "kibot_errors.filter" already exists in /home/ryan/dev/python/kicad-helpers/_temp/.gitignore + + + +To see the options that are available, run the command: + +```sh +> kh_update --help +``` + + usage: kh_update [-h] [--v] [--overwrite] [--root ROOT] + + Setup a new project (or update an existing project) with templates from the `kicad_helpers/templates` directory. Also + installs git filters to prevent insignificant changes to the kicad `*.pro` and `*.sch` files from being tracked by git + (see https://jnavila.github.io/plotkicadsch/ for more details). + + optional arguments: + -h, --help show this help message and exit + --v verbose (default: False) + --overwrite overwrite existing templates (default: False) + --root ROOT project root directory (default: .) + + + +## Export a BOM from the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --group -aq -x /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch -i /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv + + + + +## Import data from the BOM into the KiCad schematic + +```sh +> kh_sch_to_bom --v +``` + + /home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield -r --nobackup --overwrite --fields ~quantity -x /home/ryan/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv -i /home/ryan/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch + + + + +## Run all tests in the `tests` directory + +```sh +> kh_test +``` + + testing /home/ryan/dev/python/kicad-helpers/_temp/tests/Tests.ipynb + All tests are passing! + + + +## Contributors + +* Ryan Fobel ([@ryanfobel](https://github.com/ryanfobel)) + + + + +%prep +%autosetup -n kicad-helpers-0.14 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-kicad-helpers -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.14-1 +- Package Spec generated @@ -0,0 +1 @@ +7bb43d25b3556c708a850b8f9f9c1471 kicad_helpers-0.14.tar.gz |