[DOCs][Dependencies] Added Python module and tool images
This commit is contained in:
Salvador E. Tropea
parent
bdd4131d32
commit
d15e20d8b9
44
README.md
44
README.md
|
|
@ -21,6 +21,11 @@
|
|||
|
||||
* [Introduction](#introduction)
|
||||
* [Installation](#installation)
|
||||
* [Dependencies](#dependencies)
|
||||
* [Installation on Ubuntu/Debian](#installation-on-ubuntu/debian)
|
||||
* [Installation using pip](#installation-using-pip)
|
||||
* [Notes about virtualenv](#notes-about-virtualenv)
|
||||
* [Installation on other targets](#installation-on-other-targets)
|
||||
* [Configuration](#configuration)
|
||||
* [The header](#the-header)
|
||||
* [The *preflight* section](#the-preflight-section)
|
||||
|
|
@ -105,43 +110,45 @@ Notes:
|
|||
Comment or remove lines like this: `<policy domain="coder" rights="none" pattern="PDF" />` (On Debian: `/etc/ImageMagick-6/policy.xml`)
|
||||
-  Link to Debian stable package.
|
||||
-  This is a Python dependency from PyPi and will be installed when using `pip`
|
||||
-  This is a Python module, not a separated tool.
|
||||
-  This is an independent tool, can be a binary or a Python script.
|
||||
|
||||
[**Distutils**](https://pypi.org/project/Distutils/) (python module) [](https://packages.debian.org/bullseye/python3-distutils)
|
||||
[**Distutils**](https://pypi.org/project/Distutils/)  [](https://packages.debian.org/bullseye/python3-distutils)
|
||||
- Mandatory
|
||||
|
||||
[**PyYAML**](https://pypi.org/project/PyYAML/) (python module)  [](https://packages.debian.org/bullseye/python3-yaml)
|
||||
[**PyYAML**](https://pypi.org/project/PyYAML/)   [](https://packages.debian.org/bullseye/python3-yaml)
|
||||
- Mandatory
|
||||
|
||||
[**Requests**](https://pypi.org/project/Requests/) (python module)  [](https://packages.debian.org/bullseye/python3-requests)
|
||||
[**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 (tool)  (Auto-download)
|
||||
[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13   (Auto-download)
|
||||
- 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 (tool) (Auto-download)
|
||||
[**KiCost**](https://github.com/hildogjr/KiCost) v1.1.8  (Auto-download)
|
||||
- Mandatory for `kicost`
|
||||
- Optional to find components costs and specs for `bom`
|
||||
|
||||
[**PcbDraw**](https://github.com/INTI-CMNB/pcbdraw) v0.9.0 (tool) (Auto-download)
|
||||
[**PcbDraw**](https://github.com/INTI-CMNB/pcbdraw) v0.9.0  (Auto-download)
|
||||
- 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 (tool)
|
||||
[**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 (tool) (Auto-download)
|
||||
[**KiBoM**](https://github.com/INTI-CMNB/KiBoM) v1.8.0  (Auto-download)
|
||||
- Mandatory for `kibom`
|
||||
|
||||
[**LXML**](https://pypi.org/project/LXML/) (python module) [](https://packages.debian.org/bullseye/python3-lxml)
|
||||
[**LXML**](https://pypi.org/project/LXML/)  [](https://packages.debian.org/bullseye/python3-lxml)
|
||||
- Mandatory for `pcb_print`
|
||||
|
||||
[**QRCodeGen**](https://pypi.org/project/QRCodeGen/) (python module)  [](https://packages.debian.org/bullseye/python3-qrcodegen)
|
||||
[**QRCodeGen**](https://pypi.org/project/QRCodeGen/)   [](https://packages.debian.org/bullseye/python3-qrcodegen)
|
||||
- Mandatory for `qr_lib`
|
||||
|
||||
[**Colorama**](https://pypi.org/project/Colorama/) (python module)  [](https://packages.debian.org/bullseye/python3-colorama)
|
||||
[**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 (tool) [](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) (Auto-download)
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create PNG icons for `navigate_results`
|
||||
|
|
@ -149,30 +156,30 @@ Notes:
|
|||
- Create EPS format for `pcb_print` (v2.40)
|
||||
- Create PNG and JPG images for `pcbdraw`
|
||||
|
||||
[**Git**](https://git-scm.com/) (tool) [](https://packages.debian.org/bullseye/git) (Auto-download)
|
||||
[**Git**](https://git-scm.com/)  [](https://packages.debian.org/bullseye/git) (Auto-download)
|
||||
- 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/) (tool) [](https://packages.debian.org/bullseye/imagemagick) (Auto-download)
|
||||
[**ImageMagick**](https://imagemagick.org/)  [](https://packages.debian.org/bullseye/imagemagick) (Auto-download)
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create monochrome prints for `pcb_print`
|
||||
- Create JPG images for `pcbdraw`
|
||||
|
||||
[**Ghostscript**](https://www.ghostscript.com/) (tool) [](https://packages.debian.org/bullseye/ghostscript) (Auto-download)
|
||||
[**Ghostscript**](https://www.ghostscript.com/)  [](https://packages.debian.org/bullseye/ghostscript) (Auto-download)
|
||||
- Optional to:
|
||||
- Create outputs preview for `navigate_results`
|
||||
- Create PS files for `pcb_print`
|
||||
|
||||
[**Pandoc**](https://pandoc.org/) (tool) [](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/) (tool) [](https://packages.debian.org/bullseye/rar) (Auto-download)
|
||||
[**RAR**](https://www.rarlab.com/)  [](https://packages.debian.org/bullseye/rar) (Auto-download)
|
||||
- Optional to compress in RAR format for `compress`
|
||||
|
||||
[**XLSXWriter**](https://pypi.org/project/XLSXWriter/) (python module)  [](https://packages.debian.org/bullseye/python3-xlsxwriter)
|
||||
[**XLSXWriter**](https://pypi.org/project/XLSXWriter/)   [](https://packages.debian.org/bullseye/python3-xlsxwriter)
|
||||
- Optional to create XLSX files for `bom`
|
||||
|
||||
|
||||
|
|
@ -3751,4 +3758,5 @@ Additionally we support:
|
|||
- **Robot in the logo**: Christian Plaza (from pixabay)
|
||||
- **Robot arm in assembly_simple.svg**: [Pixlok](https://pixlok.com/)
|
||||
- **Chip in assembly_simple.svg**: [oNline Web Fonts](https://www.onlinewebfonts.com/)
|
||||
- **Wrench**: [Freepik - Flaticon](https://www.flaticon.es/iconos-gratis/llave-inglesa)
|
||||
- **Most icons for the navigate_results output**: The KiCad project
|
||||
|
|
|
|||
|
|
@ -110,6 +110,8 @@ Notes:
|
|||
Comment or remove lines like this: `<policy domain="coder" rights="none" pattern="PDF" />` (On Debian: `/etc/ImageMagick-6/policy.xml`)
|
||||
-  Link to Debian stable package.
|
||||
-  This is a Python dependency from PyPi and will be installed when using `pip`
|
||||
-  This is a Python module, not a separated tool.
|
||||
-  This is an independent tool, can be a binary or a Python script.
|
||||
|
||||
@dependencies@
|
||||
|
||||
|
|
@ -1723,4 +1725,5 @@ Additionally we support:
|
|||
- **Robot in the logo**: Christian Plaza (from pixabay)
|
||||
- **Robot arm in assembly_simple.svg**: [Pixlok](https://pixlok.com/)
|
||||
- **Chip in assembly_simple.svg**: [oNline Web Fonts](https://www.onlinewebfonts.com/)
|
||||
- **Wrench**: [Freepik - Flaticon](https://www.flaticon.es/iconos-gratis/llave-inglesa)
|
||||
- **Most icons for the navigate_results output**: The KiCad project
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 806 B |
|
|
@ -0,0 +1,113 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://web.resource.org/cc/"
|
||||
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:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
width="110.4211"
|
||||
height="109.8461"
|
||||
id="svg2169"
|
||||
sodipodi:version="0.32"
|
||||
inkscape:version="0.45.1"
|
||||
version="1.0"
|
||||
sodipodi:docbase="/home/bene/Desktop"
|
||||
sodipodi:docname="dessin-1.svg"
|
||||
inkscape:output_extension="org.inkscape.output.svg.inkscape">
|
||||
<defs
|
||||
id="defs2171">
|
||||
<linearGradient
|
||||
id="linearGradient11301"
|
||||
inkscape:collect="always">
|
||||
<stop
|
||||
id="stop11303"
|
||||
offset="0"
|
||||
style="stop-color:#ffe052;stop-opacity:1" />
|
||||
<stop
|
||||
id="stop11305"
|
||||
offset="1"
|
||||
style="stop-color:#ffc331;stop-opacity:1" />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
gradientUnits="userSpaceOnUse"
|
||||
y2="168.1012"
|
||||
x2="147.77737"
|
||||
y1="111.92053"
|
||||
x1="89.136749"
|
||||
id="linearGradient11307"
|
||||
xlink:href="#linearGradient11301"
|
||||
inkscape:collect="always" />
|
||||
<linearGradient
|
||||
id="linearGradient9515"
|
||||
inkscape:collect="always">
|
||||
<stop
|
||||
id="stop9517"
|
||||
offset="0"
|
||||
style="stop-color:#387eb8;stop-opacity:1" />
|
||||
<stop
|
||||
id="stop9519"
|
||||
offset="1"
|
||||
style="stop-color:#366994;stop-opacity:1" />
|
||||
</linearGradient>
|
||||
<linearGradient
|
||||
gradientUnits="userSpaceOnUse"
|
||||
y2="131.85291"
|
||||
x2="110.14919"
|
||||
y1="77.070274"
|
||||
x1="55.549179"
|
||||
id="linearGradient9521"
|
||||
xlink:href="#linearGradient9515"
|
||||
inkscape:collect="always" />
|
||||
</defs>
|
||||
<sodipodi:namedview
|
||||
id="base"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1.0"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:zoom="0.24748737"
|
||||
inkscape:cx="-260.46312"
|
||||
inkscape:cy="316.02744"
|
||||
inkscape:document-units="px"
|
||||
inkscape:current-layer="layer1"
|
||||
width="131.10236px"
|
||||
height="184.25197px"
|
||||
inkscape:window-width="872"
|
||||
inkscape:window-height="624"
|
||||
inkscape:window-x="5"
|
||||
inkscape:window-y="48" />
|
||||
<metadata
|
||||
id="metadata2174">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
inkscape:label="Calque 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1"
|
||||
transform="translate(-473.36088,-251.72485)">
|
||||
<g
|
||||
id="g1894"
|
||||
transform="translate(428.42338,184.2561)">
|
||||
<path
|
||||
style="opacity:1;color:#000000;fill:url(#linearGradient9521);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
|
||||
d="M 99.75,67.46875 C 71.718268,67.468752 73.46875,79.625 73.46875,79.625 L 73.5,92.21875 L 100.25,92.21875 L 100.25,96 L 62.875,96 C 62.875,96 44.9375,93.965724 44.9375,122.25 C 44.937498,150.53427 60.59375,149.53125 60.59375,149.53125 L 69.9375,149.53125 L 69.9375,136.40625 C 69.9375,136.40625 69.433848,120.75 85.34375,120.75 C 101.25365,120.75 111.875,120.75 111.875,120.75 C 111.875,120.75 126.78125,120.99096 126.78125,106.34375 C 126.78125,91.696544 126.78125,82.125 126.78125,82.125 C 126.78125,82.124998 129.04443,67.46875 99.75,67.46875 z M 85,75.9375 C 87.661429,75.937498 89.8125,78.088571 89.8125,80.75 C 89.812502,83.411429 87.661429,85.5625 85,85.5625 C 82.338571,85.562502 80.1875,83.411429 80.1875,80.75 C 80.187498,78.088571 82.338571,75.9375 85,75.9375 z "
|
||||
id="path8615" />
|
||||
<path
|
||||
id="path8620"
|
||||
d="M 100.5461,177.31485 C 128.57784,177.31485 126.82735,165.1586 126.82735,165.1586 L 126.7961,152.56485 L 100.0461,152.56485 L 100.0461,148.7836 L 137.4211,148.7836 C 137.4211,148.7836 155.3586,150.81787 155.3586,122.53359 C 155.35861,94.249323 139.70235,95.252343 139.70235,95.252343 L 130.3586,95.252343 L 130.3586,108.37734 C 130.3586,108.37734 130.86226,124.03359 114.95235,124.03359 C 99.042448,124.03359 88.421098,124.03359 88.421098,124.03359 C 88.421098,124.03359 73.514848,123.79263 73.514848,138.43985 C 73.514848,153.08705 73.514848,162.6586 73.514848,162.6586 C 73.514848,162.6586 71.251668,177.31485 100.5461,177.31485 z M 115.2961,168.8461 C 112.63467,168.8461 110.4836,166.69503 110.4836,164.0336 C 110.4836,161.37217 112.63467,159.2211 115.2961,159.2211 C 117.95753,159.2211 120.1086,161.37217 120.1086,164.0336 C 120.10861,166.69503 117.95753,168.8461 115.2961,168.8461 z "
|
||||
style="opacity:1;color:#000000;fill:url(#linearGradient11307);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 5.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
|
|
@ -32,7 +32,9 @@ GLOBAL_MANDATORY = LOCAL_MANDATORY*100
|
|||
DEB_LOGO = ''
|
||||
PYPI_LOGO = ('')
|
||||
|
||||
PY_LOGO = ('')
|
||||
TOOL_LOGO = ''
|
||||
|
||||
try:
|
||||
import yaml
|
||||
|
|
@ -738,10 +740,10 @@ 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):
|
||||
dtype = 'python module' if dep.is_python else 'tool'
|
||||
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 ''
|
||||
if dep.is_python:
|
||||
url = 'https://pypi.org/project/{}/'.format(name)
|
||||
|
|
@ -751,6 +753,7 @@ def print_dependencies(markdown=True, jsn=False):
|
|||
if dep.in_debian:
|
||||
deb = ' [{}](https://packages.debian.org/bullseye/{})'.format(DEB_LOGO, dep.deb_package)
|
||||
else:
|
||||
dtype = ' (Python module)' if dep.is_python else ' (Tool)'
|
||||
is_pypi_dep = ' (PyPi dependency)' if dep.pypi_name.lower() in __pypi_deps__ else ''
|
||||
if dep.in_debian:
|
||||
deb = ' (Debian: {})'.format(dep.deb_package)
|
||||
|
|
@ -766,8 +769,8 @@ def print_dependencies(markdown=True, jsn=False):
|
|||
version = r.version
|
||||
ver = ''
|
||||
if version:
|
||||
ver = 'v'+'.'.join(map(str, version))+' '
|
||||
print("{} {}({}){}{}{}".format(name, ver, dtype, is_pypi_dep, deb, has_dowloader))
|
||||
ver = 'v'+'.'.join(map(str, version))
|
||||
print("{} {}{}{}{}{}".format(name, ver, dtype, is_pypi_dep, deb, has_dowloader))
|
||||
if needed:
|
||||
if len(needed) == 1:
|
||||
if needed[0] == 'general use':
|
||||
|
|
|
|||
Loading…
Reference in New Issue