KiBot/docs/source/dependencies.rst

259 lines
15 KiB
ReStructuredText

.. Automatically generated by KiBot, please don't edit this file
`Lark <https://pypi.org/project/Lark/>`__ :index:`: <pair: dependency; Lark>` |image1| |image2| |image3|
- Mandatory
`PyYAML <https://pypi.org/project/PyYAML/>`__ :index:`: <pair: dependency; PyYAML>` |image4| |image5| |image6|
- Mandatory
`Requests <https://pypi.org/project/Requests/>`__ :index:`: <pair: dependency; Requests>` |image7| |image8| |image9|
- Mandatory
`KiCad Automation tools <https://github.com/INTI-CMNB/KiAuto>`__ :index:`: <pair: dependency; KiCad Automation tools>` v2.2.1 |image10| |PyPi dependency| |Auto-download|
- Mandatory for: `dxf_sch_print`, `gencad`, `hpgl_sch_print`, `netlist`, `pdf_pcb_print`, `pdf_sch_print`, `ps_sch_print`, `render_3d`, `run_drc`, `run_erc`, `step`, `svg_pcb_print`, `svg_sch_print`, `update_xml`, `vrml`
- Optional to:
- Compare schematics for `diff` (v2.2.0)
- Show KiAuto installation information for `info` (v2.0.0)
- Compare schematics for `kiri` (v2.2.0)
- Print the page frame in GUI mode for `pcb_print` (v1.6.7)
`KiKit <https://github.com/INTI-CMNB/KiKit>`__ :index:`: <pair: dependency; KiKit>` v1.3.0.4 |image11| |Auto-download|
- Mandatory for: `panelize`, `stencil_3d`, `stencil_for_jig`
- Optional to separate multiboard projects for general use
- Note: Official 1.3.0 release does not work, use my fork if 1.3.0 is the latest
`KiCad PCB/SCH Diff <https://github.com/INTI-CMNB/KiDiff>`__ :index:`: <pair: dependency; KiCad PCB/SCH Diff>` v2.5.3 |image12| |Auto-download|
- Mandatory for: `diff`, `kiri`
`LXML <https://pypi.org/project/LXML/>`__ :index:`: <pair: dependency; LXML>` |image13| |image14| |Auto-download|
- Mandatory for: `pcb_print`, `pcbdraw`
`OpenSCAD <https://openscad.org/>`__ :index:`: <pair: dependency; OpenSCAD>` |image15| |image16|
- Mandatory for: `stencil_3d`, `stencil_for_jig`
`Xvfb <https://www.x.org>`__ :index:`: <pair: dependency; Xvfb>` |image17| |image18|
- Mandatory for: `stencil_3d`, `stencil_for_jig`
`Xvfbwrapper <https://pypi.org/project/Xvfbwrapper/>`__ :index:`: <pair: dependency; Xvfbwrapper>` |image19| |image20| |Auto-download|
- Mandatory for: `stencil_3d`, `stencil_for_jig`
`KiCost <https://github.com/hildogjr/KiCost>`__ :index:`: <pair: dependency; KiCost>` v1.1.8 |image21| |Auto-download|
- Mandatory for `kicost`
- Optional to find components costs and specs for `bom`
`Blender <https://www.blender.org/>`__ :index:`: <pair: dependency; Blender>` v3.4.0 |image22| |image23|
- Mandatory for `blender_export`
`Interactive HTML BoM <https://github.com/INTI-CMNB/InteractiveHtmlBom>`__ :index:`: <pair: dependency; Interactive HTML BoM>` v2.7.0 |image24| |Auto-download|
- Mandatory for `ibom`
`KiBoM <https://github.com/INTI-CMNB/KiBoM>`__ :index:`: <pair: dependency; KiBoM>` v1.8.0 |image25| |Auto-download|
- Mandatory for `kibom`
`markdown2 <https://pypi.org/project/markdown2/>`__ :index:`: <pair: dependency; markdown2>` |image26| |image27| |image28|
- Mandatory for `kikit_present`
`mistune <https://pypi.org/project/mistune/>`__ :index:`: <pair: dependency; mistune>` |image29| |image30|
- Mandatory for `populate`
`QRCodeGen <https://pypi.org/project/QRCodeGen/>`__ :index:`: <pair: dependency; QRCodeGen>` |image31| |image32| |image33| |Auto-download|
- Mandatory for `qr_lib`
`Colorama <https://pypi.org/project/Colorama/>`__ :index:`: <pair: dependency; Colorama>` |image34| |image35| |image36|
- Optional to get color messages in a portable way for general use
`Git <https://git-scm.com/>`__ :index:`: <pair: dependency; Git>` |image37| |image38| |Auto-download|
- Optional to:
- Compare with files in the repo for `diff`
- Find commit hash and/or date for `kikit_present`
- Compare with files in the repo for `kiri`
- Find commit hash and/or date for `pcb_replace`
- Find commit hash and/or date for `sch_replace`
- Find commit hash and/or date for `set_text_variables`
`ImageMagick <https://imagemagick.org/>`__ :index:`: <pair: dependency; ImageMagick>` |image39| |image40| |Auto-download|
- Optional to:
- Automatically crop images for `blender_export`
- Create outputs preview for `navigate_results`
- Create monochrome prints and scaled PNG files for `pcb_print`
- Create JPG and BMP images for `pcbdraw`
- Automatically crop images for `render_3d`
`RSVG tools <https://gitlab.gnome.org/GNOME/librsvg>`__ :index:`: <pair: dependency; RSVG tools>` |image41| |image42| |Auto-download|
- Optional to:
- Create outputs preview for `navigate_results`
- Create PNG icons for `navigate_results`
- Create PDF, PNG, PS and EPS formats for `pcb_print`
- Create PNG, JPG and BMP images for `pcbdraw`
`Bash <https://www.gnu.org/software/bash/>`__ :index:`: <pair: dependency; Bash>` |image43| |image44|
- Optional to:
- Run external commands to create replacement text for `pcb_replace`
- Run external commands to create replacement text for `sch_replace`
- Run external commands to create replacement text for `set_text_variables`
`Ghostscript <https://www.ghostscript.com/>`__ :index:`: <pair: dependency; Ghostscript>` |image45| |image46| |Auto-download|
- Optional to:
- Create outputs preview for `navigate_results`
- Create PNG, PS and EPS formats for `pcb_print`
`numpy <https://pypi.org/project/numpy/>`__ :index:`: <pair: dependency; numpy>` |image47| |image48| |Auto-download|
- Optional to automatically adjust SVG margin for `pcbdraw`
`Pandoc <https://pandoc.org/>`__ :index:`: <pair: dependency; Pandoc>` |image49| |image50|
- Optional to create PDF/ODF/DOCX files for `report`
- Note: In CI/CD environments: the `kicad_auto_test` docker image contains it.
`RAR <https://www.rarlab.com/>`__ :index:`: <pair: dependency; RAR>` |image51| |image52| |Auto-download|
- Optional to compress in RAR format for `compress`
`XLSXWriter <https://pypi.org/project/XLSXWriter/>`__ :index:`: <pair: dependency; XLSXWriter>` |image53| |image54| |image55| |Auto-download|
- Optional to create XLSX files for `bom`
.. |PyPi dependency| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
.. |Auto-download| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/auto_download-22x22.png
.. |image1| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/Lark/
.. |image2| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/Lark/
.. |image3| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-lark
.. |image4| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/PyYAML/
.. |image5| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/PyYAML/
.. |image6| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-yaml
.. |image7| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/Requests/
.. |image8| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/Requests/
.. |image9| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-requests
.. |image10| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/INTI-CMNB/KiAuto
.. |image11| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/INTI-CMNB/KiKit
.. |image12| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/INTI-CMNB/KiDiff
.. |image13| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/LXML/
.. |image14| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-lxml
.. |image15| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://openscad.org/
.. |image16| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/openscad
.. |image17| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://www.x.org
.. |image18| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/xvfb
.. |image19| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/Xvfbwrapper/
.. |image20| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-xvfbwrapper
.. |image21| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/hildogjr/KiCost
.. |image22| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://www.blender.org/
.. |image23| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/blender
.. |image24| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/INTI-CMNB/InteractiveHtmlBom
.. |image25| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://github.com/INTI-CMNB/KiBoM
.. |image26| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/markdown2/
.. |image27| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/markdown2/
.. |image28| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-markdown2
.. |image29| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/mistune/
.. |image30| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-mistune
.. |image31| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/QRCodeGen/
.. |image32| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/QRCodeGen/
.. |image33| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-qrcodegen
.. |image34| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/Colorama/
.. |image35| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/Colorama/
.. |image36| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-colorama
.. |image37| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://git-scm.com/
.. |image38| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/git
.. |image39| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://imagemagick.org/
.. |image40| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/imagemagick
.. |image41| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://gitlab.gnome.org/GNOME/librsvg
.. |image42| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/librsvg2-bin
.. |image43| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://www.gnu.org/software/bash/
.. |image44| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/bash
.. |image45| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://www.ghostscript.com/
.. |image46| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/ghostscript
.. |image47| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/numpy/
.. |image48| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-numpy
.. |image49| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://pandoc.org/
.. |image50| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/pandoc
.. |image51| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png
:target: https://www.rarlab.com/
.. |image52| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/rar
.. |image53| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png
:target: https://pypi.org/project/XLSXWriter/
.. |image54| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png
:target: https://pypi.org/project/XLSXWriter/
.. |image55| image:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png
:target: https://packages.debian.org/stable/python3-xlsxwriter