diff --git a/README.md b/README.md index 16908955..623cf088 100644 --- a/README.md +++ b/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: `` (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` +- ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) This is a Python module, not a separated tool. +- ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) This is an independent tool, can be a binary or a Python script. -[**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) +[**Distutils**](https://pypi.org/project/Distutils/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) [![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](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) +[**PyYAML**](https://pypi.org/project/PyYAML/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) ![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](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) +[**Requests**](https://pypi.org/project/Requests/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) ![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](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) (Auto-download) +[**KiCad Automation tools**](https://github.com/INTI-CMNB/KiAuto) v1.6.13 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) ![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) +[**KiCost**](https://github.com/hildogjr/KiCost) v1.1.8 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) (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 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) (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 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) - 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 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) (Auto-download) - Mandatory for `kibom` -[**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) +[**LXML**](https://pypi.org/project/LXML/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) [![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](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) +[**QRCodeGen**](https://pypi.org/project/QRCodeGen/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) ![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](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) +[**Colorama**](https://pypi.org/project/Colorama/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) ![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) +[**RSVG tools**](https://gitlab.gnome.org/GNOME/librsvg) v2.40 ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](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) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/git) (Auto-download) +[**Git**](https://git-scm.com/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](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) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/imagemagick) (Auto-download) +[**ImageMagick**](https://imagemagick.org/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](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) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/ghostscript) (Auto-download) +[**Ghostscript**](https://www.ghostscript.com/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](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) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/pandoc) +[**Pandoc**](https://pandoc.org/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![Debian](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/debian-openlogo-22x22.png)](https://packages.debian.org/bullseye/pandoc) - Optional to create PDF/ODF/DOCX files for `report` -[**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) +[**RAR**](https://www.rarlab.com/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) [![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](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) +[**XLSXWriter**](https://pypi.org/project/XLSXWriter/) ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) ![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` @@ -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 diff --git a/docs/README.in b/docs/README.in index 3f24b085..595c7d3a 100644 --- a/docs/README.in +++ b/docs/README.in @@ -110,6 +110,8 @@ Notes: 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` +- ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Python-logo-notext-22x22.png) This is a Python module, not a separated tool. +- ![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png) 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 diff --git a/docs/images/Python-logo-notext-22x22.png b/docs/images/Python-logo-notext-22x22.png new file mode 100644 index 00000000..e509381a Binary files /dev/null and b/docs/images/Python-logo-notext-22x22.png differ diff --git a/docs/images/Python-logo-notext.svg b/docs/images/Python-logo-notext.svg new file mode 100644 index 00000000..366f52f3 --- /dev/null +++ b/docs/images/Python-logo-notext.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/docs/images/llave-inglesa-22x22.png b/docs/images/llave-inglesa-22x22.png new file mode 100644 index 00000000..667771e0 Binary files /dev/null and b/docs/images/llave-inglesa-22x22.png differ diff --git a/docs/images/llave-inglesa.png b/docs/images/llave-inglesa.png new file mode 100644 index 00000000..099a8f9b Binary files /dev/null and b/docs/images/llave-inglesa.png differ diff --git a/kibot/config_reader.py b/kibot/config_reader.py index 9ca87681..01f4f1eb 100644 --- a/kibot/config_reader.py +++ b/kibot/config_reader.py @@ -32,7 +32,9 @@ 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)') - +PY_LOGO = ('![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/' + 'docs/images/Python-logo-notext-22x22.png)') +TOOL_LOGO = '![Python module](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/llave-inglesa-22x22.png)' 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':