[DOCs][Dependencies] Added auto-download image
This commit is contained in:
Salvador E. Tropea
parent
5e15d694e3
commit
6cc1feeae5
24
README.md
24
README.md
|
|
@ -103,7 +103,7 @@ You can also run KiBot using docker images in a CI/CD environment like GitHub or
|
|||
Notes:
|
||||
- When installing from the Debian repo you don't need to worry about dependencies, just pay attention to *recommended* and *suggested* packages.
|
||||
- When installing using `pip` the dependencies marked with  will be automatically installed.
|
||||
- The dependencies marked with **Auto-download** can be downloaded on-demand by KiBot.
|
||||
- The dependencies marked with  can be downloaded on-demand by KiBot.
|
||||
Note this is experimental and is mostly oriented to 64 bits Linux systems.
|
||||
- The `kibot-check` tool can help you to know which dependencies are missing.
|
||||
- Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file.
|
||||
|
|
@ -121,21 +121,21 @@ Notes:
|
|||
[**Requests**](https://pypi.org/project/Requests/)   [](https://packages.debian.org/bullseye/python3-requests)
|
||||
- Mandatory
|
||||
|
||||
[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13   (Auto-download)
|
||||
[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13   
|
||||
- Mandatory for: `gencad`, `netlist`, `pdf_pcb_print`, `pdf_sch_print`, `render_3d`, `run_drc`, `run_erc`, `step`, `svg_pcb_print`, `svg_sch_print`, `update_xml`
|
||||
|
||||
[**KiCost**](https://github.com/hildogjr/KiCost) v1.1.8  (Auto-download)
|
||||
[**KiCost**](https://github.com/hildogjr/KiCost) v1.1.8  
|
||||
- Mandatory for `kicost`
|
||||
- Optional to find components costs and specs for `bom`
|
||||
|
||||
[**PcbDraw**](https://github.com/INTI-CMNB/pcbdraw) v0.9.0  (Auto-download)
|
||||
[**PcbDraw**](https://github.com/INTI-CMNB/pcbdraw) v0.9.0  
|
||||
- Mandatory for `pcbdraw`
|
||||
- Optional to create realistic solder masks for `pcb_print`
|
||||
|
||||
[**Interactive HTML BoM**](https://github.com/INTI-CMNB/InteractiveHtmlBom) v2.4.1.4 
|
||||
[**Interactive HTML BoM**](https://github.com/INTI-CMNB/InteractiveHtmlBom) v2.4.1.4 
|
||||
- Mandatory for `ibom`
|
||||
|
||||
[**KiBoM**](https://github.com/INTI-CMNB/KiBoM) v1.8.0  (Auto-download)
|
||||
[**KiBoM**](https://github.com/INTI-CMNB/KiBoM) v1.8.0  
|
||||
- Mandatory for `kibom`
|
||||
|
||||
[**LXML**](https://pypi.org/project/LXML/)  [](https://packages.debian.org/bullseye/python3-lxml)
|
||||
|
|
@ -147,7 +147,7 @@ Notes:
|
|||
[**Colorama**](https://pypi.org/project/Colorama/)   [](https://packages.debian.org/bullseye/python3-colorama)
|
||||
- Optional to get color messages in a portable way for general use
|
||||
|
||||
[**RSVG tools**](https://gitlab.gnome.org/GNOME/librsvg) v2.40  [](https://packages.debian.org/bullseye/librsvg2-bin) (Auto-download)
|
||||
[**RSVG tools**](https://gitlab.gnome.org/GNOME/librsvg) v2.40  [](https://packages.debian.org/bullseye/librsvg2-bin) 
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create PNG icons for `navigate_results`
|
||||
|
|
@ -155,27 +155,27 @@ Notes:
|
|||
- Create EPS format for `pcb_print` (v2.40)
|
||||
- Create PNG and JPG images for `pcbdraw`
|
||||
|
||||
[**Git**](https://git-scm.com/)  [](https://packages.debian.org/bullseye/git) (Auto-download)
|
||||
[**Git**](https://git-scm.com/)  [](https://packages.debian.org/bullseye/git) 
|
||||
- Optional to:
|
||||
- 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/)  [](https://packages.debian.org/bullseye/imagemagick) (Auto-download)
|
||||
[**ImageMagick**](https://imagemagick.org/)  [](https://packages.debian.org/bullseye/imagemagick) 
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create monochrome prints for `pcb_print`
|
||||
- Create JPG images for `pcbdraw`
|
||||
|
||||
[**Ghostscript**](https://www.ghostscript.com/)  [](https://packages.debian.org/bullseye/ghostscript) (Auto-download)
|
||||
[**Ghostscript**](https://www.ghostscript.com/)  [](https://packages.debian.org/bullseye/ghostscript) 
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create PS files for `pcb_print`
|
||||
|
||||
[**Pandoc**](https://pandoc.org/)  [](https://packages.debian.org/bullseye/pandoc)
|
||||
[**Pandoc**](https://pandoc.org/)  [](https://packages.debian.org/bullseye/pandoc)
|
||||
- Optional to create PDF/ODF/DOCX files for `report`
|
||||
|
||||
[**RAR**](https://www.rarlab.com/)  [](https://packages.debian.org/bullseye/rar) (Auto-download)
|
||||
[**RAR**](https://www.rarlab.com/)  [](https://packages.debian.org/bullseye/rar) 
|
||||
- Optional to compress in RAR format for `compress`
|
||||
|
||||
[**XLSXWriter**](https://pypi.org/project/XLSXWriter/)   [](https://packages.debian.org/bullseye/python3-xlsxwriter)
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ You can also run KiBot using docker images in a CI/CD environment like GitHub or
|
|||
Notes:
|
||||
- When installing from the Debian repo you don't need to worry about dependencies, just pay attention to *recommended* and *suggested* packages.
|
||||
- When installing using `pip` the dependencies marked with  will be automatically installed.
|
||||
- The dependencies marked with **Auto-download** can be downloaded on-demand by KiBot.
|
||||
- The dependencies marked with  can be downloaded on-demand by KiBot.
|
||||
Note this is experimental and is mostly oriented to 64 bits Linux systems.
|
||||
- The `kibot-check` tool can help you to know which dependencies are missing.
|
||||
- Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file.
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 1015 B |
|
|
@ -0,0 +1,138 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
id="Слой_1"
|
||||
data-name="Слой 1"
|
||||
viewBox="0 0 16 17"
|
||||
version="1.1"
|
||||
sodipodi:docname="auto_download.svg"
|
||||
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"
|
||||
width="16"
|
||||
height="17"
|
||||
inkscape:export-filename="/home/salvador/0Data/Eccosur/kibot/docs/images/icon_sources/zip.png"
|
||||
inkscape:export-xdpi="124.23529"
|
||||
inkscape:export-ydpi="124.23529">
|
||||
<sodipodi:namedview
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1"
|
||||
objecttolerance="10"
|
||||
gridtolerance="10"
|
||||
guidetolerance="10"
|
||||
inkscape:pageopacity="0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:window-width="1920"
|
||||
inkscape:window-height="983"
|
||||
id="namedview30"
|
||||
showgrid="true"
|
||||
inkscape:zoom="27.961538"
|
||||
inkscape:cx="-1.3485641"
|
||||
inkscape:cy="8.5589849"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="27"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:document-rotation="0"
|
||||
inkscape:current-layer="Слой_1">
|
||||
<inkscape:grid
|
||||
type="xygrid"
|
||||
id="grid_kicad"
|
||||
spacingx="0.5"
|
||||
spacingy="0.5"
|
||||
color="#9999ff"
|
||||
opacity="0.13"
|
||||
empspacing="2"
|
||||
originx="-4.0850909"
|
||||
originy="-5" />
|
||||
</sodipodi:namedview>
|
||||
<metadata
|
||||
id="metadata43">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<cc:license
|
||||
rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/" />
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title>add_arc</dc:title>
|
||||
</cc:Work>
|
||||
<cc:License
|
||||
rdf:about="http://creativecommons.org/licenses/by-sa/4.0/">
|
||||
<cc:permits
|
||||
rdf:resource="http://creativecommons.org/ns#Reproduction" />
|
||||
<cc:permits
|
||||
rdf:resource="http://creativecommons.org/ns#Distribution" />
|
||||
<cc:requires
|
||||
rdf:resource="http://creativecommons.org/ns#Notice" />
|
||||
<cc:requires
|
||||
rdf:resource="http://creativecommons.org/ns#Attribution" />
|
||||
<cc:permits
|
||||
rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
|
||||
<cc:requires
|
||||
rdf:resource="http://creativecommons.org/ns#ShareAlike" />
|
||||
</cc:License>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<defs
|
||||
id="defs27736">
|
||||
<inkscape:perspective
|
||||
sodipodi:type="inkscape:persp3d"
|
||||
inkscape:vp_x="0 : 8.5 : 1"
|
||||
inkscape:vp_y="0 : 1000 : 0"
|
||||
inkscape:vp_z="16 : 8.5 : 1"
|
||||
inkscape:persp3d-origin="8 : 5.6666667 : 1"
|
||||
id="perspective1510" />
|
||||
<style
|
||||
id="style27734">.cls-1{fill:#545454;}.cls-2{fill:#e49435;}.cls-3{fill:#9e9e9e;}.cls-4{fill:#b9b9b9;}</style>
|
||||
</defs>
|
||||
<title
|
||||
id="title27738">zip</title>
|
||||
<polygon
|
||||
class="cls-1"
|
||||
points="12.883,25 12.883,10.331 24,5.82 23.989,20.14 "
|
||||
id="polygon27740"
|
||||
transform="matrix(0.72727273,0,0,0.70833333,-1.4545455,-0.70833333)"
|
||||
style="stroke-width:1.39326" />
|
||||
<polygon
|
||||
class="cls-2"
|
||||
points="12.883,25 12.883,10.05 2,5.46 2,20.084 "
|
||||
id="polygon27742"
|
||||
transform="matrix(0.72727273,0,0,0.70833333,-1.4545455,-0.70833333)"
|
||||
style="stroke-width:1.39326" />
|
||||
<polygon
|
||||
class="cls-3"
|
||||
points="24,5.82 17.927,3.3 7.369,7.895 12.894,10.41 23.761,5.92 "
|
||||
id="polygon27744"
|
||||
transform="matrix(0.72727273,0,0,0.70833333,-1.4545455,-0.70833333)"
|
||||
style="stroke-width:1.39326" />
|
||||
<polygon
|
||||
class="cls-4"
|
||||
points="17.927,3.3 12.384,1 2,5.46 7.369,7.895 "
|
||||
id="polygon27746"
|
||||
transform="matrix(0.72727273,0,0,0.70833333,-1.4545455,-0.70833333)"
|
||||
style="stroke-width:1.39326" />
|
||||
<g
|
||||
id="g1508"
|
||||
transform="matrix(0,-1.4147828,1.4147828,0,-9.0146496,4.8708781)">
|
||||
<polyline
|
||||
class="cls-5"
|
||||
points="15.362 17.16 18.111 14.406 20.861 17.16"
|
||||
id="polyline159351"
|
||||
transform="rotate(-90,4.2538501,25.74605)"
|
||||
style="fill:none;stroke:#bf2641;stroke-width:2px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
|
||||
<line
|
||||
class="cls-5"
|
||||
x1="-6.8668003"
|
||||
y1="11.8887"
|
||||
x2="0.13709927"
|
||||
y2="11.8887"
|
||||
id="line159349"
|
||||
style="fill:none;stroke:#bf2641;stroke-width:2px;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 4.6 KiB |
|
|
@ -29,12 +29,12 @@ LOCAL_OPTIONAL = 1
|
|||
GLOBAL_OPTIONAL = LOCAL_OPTIONAL*100
|
||||
LOCAL_MANDATORY = GLOBAL_OPTIONAL*100
|
||||
GLOBAL_MANDATORY = LOCAL_MANDATORY*100
|
||||
DEB_LOGO = ''
|
||||
PYPI_LOGO = ('')
|
||||
PY_LOGO = ('')
|
||||
TOOL_LOGO = ''
|
||||
GITHUB_RAW = 'https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/'
|
||||
DEB_LOGO = ''
|
||||
PYPI_LOGO = ('')
|
||||
PY_LOGO = ('')
|
||||
TOOL_LOGO = ''
|
||||
AUTO_DOWN = ''
|
||||
|
||||
try:
|
||||
import yaml
|
||||
|
|
@ -740,11 +740,11 @@ def print_dependencies(markdown=True, jsn=False):
|
|||
# Now print them sorted by importance (and by name as a second criteria)
|
||||
for name, dep in sorted(sorted(RegDependency.get_registered().items(), key=lambda x: x[0].lower()), # noqa C414
|
||||
key=lambda x: x[1].importance, reverse=True):
|
||||
has_dowloader = ' (Auto-download)' if dep.downloader is not None else ''
|
||||
deb = ''
|
||||
if markdown:
|
||||
dtype = ' '+PY_LOGO if dep.is_python else ' '+TOOL_LOGO
|
||||
is_pypi_dep = ' '+PYPI_LOGO if dep.pypi_name.lower() in __pypi_deps__ else ''
|
||||
has_dowloader = ' '+AUTO_DOWN if dep.downloader is not None else ''
|
||||
if dep.is_python:
|
||||
url = 'https://pypi.org/project/{}/'.format(name)
|
||||
else:
|
||||
|
|
@ -755,6 +755,7 @@ def print_dependencies(markdown=True, jsn=False):
|
|||
else:
|
||||
dtype = ' (Python module)' if dep.is_python else ' (Tool)'
|
||||
is_pypi_dep = ' (PyPi dependency)' if dep.pypi_name.lower() in __pypi_deps__ else ''
|
||||
has_dowloader = ' (Auto-download)' if dep.downloader is not None else ''
|
||||
if dep.in_debian:
|
||||
deb = ' (Debian: {})'.format(dep.deb_package)
|
||||
needed = []
|
||||
|
|
|
|||
Loading…
Reference in New Issue