From b1726e09153b5e8543220503ad49ce9ebf465c9b Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Thu, 30 Jun 2022 07:07:11 -0300 Subject: [PATCH] [DOCs][Dependencies] Added PyPi logo --- README.md | 13 +- docs/README.in | 1 + docs/images/PyPI_logo_simplified-22x22.png | Bin 0 -> 1694 bytes docs/images/PyPI_logo_simplified.svg | 239 +++++++++++++++++++++ kibot/config_reader.py | 9 +- 5 files changed, 252 insertions(+), 10 deletions(-) create mode 100644 docs/images/PyPI_logo_simplified-22x22.png create mode 100644 docs/images/PyPI_logo_simplified.svg diff --git a/README.md b/README.md index b219fe83..16908955 100644 --- a/README.md +++ b/README.md @@ -104,17 +104,18 @@ Notes: - Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file. Comment or remove lines like this: `` (On Debian: `/etc/ImageMagick-6/policy.xml`) - ![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png) Link to Debian stable package. +- ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) This is a Python dependency from PyPi and will be installed when using `pip` [**Distutils**](https://pypi.org/project/Distutils/) (python module) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-distutils) - Mandatory -[**PyYAML**](https://pypi.org/project/PyYAML/) (python module) (PyPi dependency) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-yaml) +[**PyYAML**](https://pypi.org/project/PyYAML/) (python module) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-yaml) - Mandatory -[**Requests**](https://pypi.org/project/Requests/) (python module) (PyPi dependency) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-requests) +[**Requests**](https://pypi.org/project/Requests/) (python module) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-requests) - Mandatory -[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13 (tool) (PyPi dependency) (Auto-download) +[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13 (tool) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) (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) @@ -134,10 +135,10 @@ Notes: [**LXML**](https://pypi.org/project/LXML/) (python module) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-lxml) - Mandatory for `pcb_print` -[**QRCodeGen**](https://pypi.org/project/QRCodeGen/) (python module) (PyPi dependency) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-qrcodegen) +[**QRCodeGen**](https://pypi.org/project/QRCodeGen/) (python module) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-qrcodegen) - Mandatory for `qr_lib` -[**Colorama**](https://pypi.org/project/Colorama/) (python module) (PyPi dependency) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-colorama) +[**Colorama**](https://pypi.org/project/Colorama/) (python module) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](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) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/librsvg2-bin) (Auto-download) @@ -171,7 +172,7 @@ Notes: [**RAR**](https://www.rarlab.com/) (tool) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/rar) (Auto-download) - Optional to compress in RAR format for `compress` -[**XLSXWriter**](https://pypi.org/project/XLSXWriter/) (python module) (PyPi dependency) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-xlsxwriter) +[**XLSXWriter**](https://pypi.org/project/XLSXWriter/) (python module) ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/python3-xlsxwriter) - Optional to create XLSX files for `bom` diff --git a/docs/README.in b/docs/README.in index 88fddb60..b13c28e1 100644 --- a/docs/README.in +++ b/docs/README.in @@ -104,6 +104,7 @@ Notes: - Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file. Comment or remove lines like this: `` (On Debian: `/etc/ImageMagick-6/policy.xml`) - ![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png) Link to Debian stable package. +- ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) This is a Python dependency from PyPi and will be installed when using `pip` @dependencies@ diff --git a/docs/images/PyPI_logo_simplified-22x22.png b/docs/images/PyPI_logo_simplified-22x22.png new file mode 100644 index 0000000000000000000000000000000000000000..4cc1e8918d94c5e93da23ec01c484be2f64e2bb9 GIT binary patch literal 1694 zcmV;P24VS$P)EX>4Tx04R}tkv&MmKpe$iTeTt;1v`i+WT;LSM8%Iyt5Adrp;l+0Yt2!bCVj!sUBE>hzEl0u6Z503ls?%w0>9pJAPnQFF-0IFsg z$#_giXI6yZE7~xCZcJlRVx~STiV1j*uY36TdKcwc-sk=tol4eZfKMQvVY*=vuMn3h_Ddut66je&o9B@*C&8!+xF_Hd4ts;xMt0Z(_NLS;0_=$B83~s!_f_ z?Xtpoi?doRv-&;x3qx6Ld5P;Z`w_)^E_c?x%Tr#;f zz{oL=5>!ZzAN&t~cWdUxM%|=P3}}6^?T^gij5AvscjrazYh-p}ZpGC@|;fw>S6p@0ogkKL%rR;zFUad;kCd24YJ`L;(K){{a7>y{D4^000SaNLh0L z00PAT00PAUiPnGb00007bV*G`2j&JI3IPYXr=|x000f#zL_t(I%f*#lY*a-Q$Ny($ z?%lh4x7*$A+7F;Cbyp}26llZ(H3%_E2vMs^Ef2={(DX$TA54gZm|#K>Ni-UL@T2iT zOca5{7ZVd7@PUtr7Gi0Gq-;NET4-sv+wRxhy?17OASEpnna=a$XbFpMgt)Up}(4NpB=@>FxwHm_Jd!jHn z=xqjoHKDl%d3o)1kHV+s+>PI|gHle3;;ShI=I&Quu|&ruCA_T0Jweo*4KiIuNdQR z+Ljqx09b~wU*EkRwk04HBxfX}0nrz)`>pQP+-ObYWb#=(O zYJA4wQ#QSV1qdk%82wSZOnsoQY4cJH9MQJIcHl17vq4A6pIBYt-YD7 zV_dp%8;$WAl`g6+%S}wk(xYwl)8ieDgAo(6%^<*o-w^;1i&fnlbthjXl>s3P2*Hi} zH>WJ;7vCknpiFb!++Q6{Bdo3ZauY$u%Q`r=WR5*o9)dE8*YW4_iw2!c<*jIWm=TqR#KsUf@F(<8l*i|n-Wr!FJJ`}kw&@XaDc!V zSwnZ`F`aYPSBL$h(F%V_J8U+c^R|>q*)*x6dx z)3W+v*fuAiiK;_ps&hxf#RGdArGeRv7Q5TZb?#og{|P`j8UUn}qps_IDm*EFVZ@#% zM!v;|BthxWH^l2XZubYX1c+J*#xL^<LeMzF7KfCK8ET z08RinF+4oH&Gs9eny7U-jinM9M^?X=W6AFx+jR8Cqdo=(@Su$^ZZW07*qoM6N<$g4fL+v;Y7A literal 0 HcmV?d00001 diff --git a/docs/images/PyPI_logo_simplified.svg b/docs/images/PyPI_logo_simplified.svg new file mode 100644 index 00000000..e88155d9 --- /dev/null +++ b/docs/images/PyPI_logo_simplified.svg @@ -0,0 +1,239 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/kibot/config_reader.py b/kibot/config_reader.py index 84d99e00..f2a7b446 100644 --- a/kibot/config_reader.py +++ b/kibot/config_reader.py @@ -29,6 +29,9 @@ LOCAL_OPTIONAL = 1 GLOBAL_OPTIONAL = LOCAL_OPTIONAL*100 LOCAL_MANDATORY = GLOBAL_OPTIONAL*100 GLOBAL_MANDATORY = LOCAL_MANDATORY*100 +DEB_LOGO = '![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)' +PYPI_LOGO = ('![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/' + 'docs/images/PyPI_logo_simplified-22x22.png)') try: @@ -736,7 +739,7 @@ def print_dependencies(markdown=True, jsn=False): 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' - is_pypi_dep = ' (PyPi dependency)' if dep.pypi_name.lower() in __pypi_deps__ else '' + is_pypi_dep = ' '+PYPI_LOGO if dep.pypi_name.lower() in __pypi_deps__ else '' has_dowloader = ' (Auto-download)' if dep.downloader is not None else '' deb = '' if markdown: @@ -746,9 +749,7 @@ def print_dependencies(markdown=True, jsn=False): url = dep.url name = '[**{}**]({})'.format(name, url) if dep.in_debian: - img = ('![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/' - 'docs/images/debian-openlogo-22x22.png)') - deb = ' [{}](https://packages.debian.org/bullseye/{})'.format(img, dep.deb_package) + deb = ' [{}](https://packages.debian.org/bullseye/{})'.format(DEB_LOGO, dep.deb_package) needed = [] optional = [] version = None