templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[CLI][Added] defs-from-env allows using environment vars for substitution 

Closes #549
This commit is contained in:
Salvador E. Tropea 2024-01-08 10:31:15 -03:00
parent 2ba5b7101c
commit 7c7d3aff0b
4 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `--help-list-offsets` to list footprint offsets (JLCPCB) - `--help-list-offsets` to list footprint offsets (JLCPCB)
- `--help-list-rotations` to list footprint rotations (JLCPCB) - `--help-list-rotations` to list footprint rotations (JLCPCB)
- `--stop-on-warnings` (`-W`) to stop on warnings (#545) - `--stop-on-warnings` (`-W`) to stop on warnings (#545)
- `--defs-from-env` allows using environment vars for substitution (#549)
- Global options: - Global options:
- `remove_solder_mask_for_dnp` similar to `remove_solder_paste_for_dnp` but - `remove_solder_mask_for_dnp` similar to `remove_solder_paste_for_dnp` but
applied to the solder mask apertures. (#476) applied to the solder mask apertures. (#476)

2
docs/source/configuration/substitution.rst
View File

@ -24,6 +24,8 @@ files.
You can use ``-E`` as many times as you need. You can use ``-E`` as many times as you need.
Also note that the ``--def-from-env`` option adds all the environment
variables as definitions.
.. index:: .. index::
pair: definitions; default pair: definitions; default

9
docs/source/usage.txt
View File

@ -3,10 +3,11 @@ KiBot: KiCad automation tool for documents generation
Usage: Usage:
kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE]
[-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ... [-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ...
[-E DEF] ... [-w LIST] [-D | -W] [--banner N] [TARGET...] [-E DEF] ... [--defs-from-env] [-w LIST] [-D | -W] [--banner N]
[TARGET...]
kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N] kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N]
[-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names] [-E DEF] ... [--defs-from-env] [--config-outs]
[--output-name-first] --list [--only-pre|--only-groups] [--only-names] [--output-name-first] --list
kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names] kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names]
--list-variants --list-variants
kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example
@ -39,6 +40,8 @@ Options:
--config-outs Configure all outputs before listing them --config-outs Configure all outputs before listing them
-d OUT_DIR, --out-dir OUT_DIR The output directory [default: .] -d OUT_DIR, --out-dir OUT_DIR The output directory [default: .]
-D, --dont-stop Try to continue if an output fails -D, --dont-stop Try to continue if an output fails
--defs-from-env Use the environment vars as preprocessor
values
-e SCHEMA, --schematic SCHEMA The schematic file (.sch/.kicad_sch) -e SCHEMA, --schematic SCHEMA The schematic file (.sch/.kicad_sch)
-E DEF, --define DEF Define preprocessor value (VAR=VAL) -E DEF, --define DEF Define preprocessor value (VAR=VAL)
-g DEF, --global-redef DEF Overwrite a global value (VAR=VAL) -g DEF, --global-redef DEF Overwrite a global value (VAR=VAL)

11
kibot/__main__.py
View File

@ -10,10 +10,11 @@
Usage: Usage:
kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE]
[-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ... [-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ...
[-E DEF] ... [-w LIST] [-D | -W] [--banner N] [TARGET...] [-E DEF] ... [--defs-from-env] [-w LIST] [-D | -W] [--banner N]
[TARGET...]
kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N] kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N]
[-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names] [-E DEF] ... [--defs-from-env] [--config-outs]
[--output-name-first] --list [--only-pre|--only-groups] [--only-names] [--output-name-first] --list
kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names] kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names]
--list-variants --list-variants
kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example
@ -46,6 +47,8 @@ Options:
--config-outs Configure all outputs before listing them --config-outs Configure all outputs before listing them
-d OUT_DIR, --out-dir OUT_DIR The output directory [default: .] -d OUT_DIR, --out-dir OUT_DIR The output directory [default: .]
-D, --dont-stop Try to continue if an output fails -D, --dont-stop Try to continue if an output fails
--defs-from-env Use the environment vars as preprocessor
values
-e SCHEMA, --schematic SCHEMA The schematic file (.sch/.kicad_sch) -e SCHEMA, --schematic SCHEMA The schematic file (.sch/.kicad_sch)
-E DEF, --define DEF Define preprocessor value (VAR=VAL) -E DEF, --define DEF Define preprocessor value (VAR=VAL)
-g DEF, --global-redef DEF Overwrite a global value (VAR=VAL) -g DEF, --global-redef DEF Overwrite a global value (VAR=VAL)
@ -340,6 +343,8 @@ def detect_kicad():
def parse_defines(args): def parse_defines(args):
if args.defs_from_env:
GS.cli_defines.update(os.environ)
for define in args.define: for define in args.define:
if '=' not in define: if '=' not in define:
GS.exit_with_error(f'Malformed `define` option, must be VARIABLE=VALUE ({define})', EXIT_BAD_ARGS) GS.exit_with_error(f'Malformed `define` option, must be VARIABLE=VALUE ({define})', EXIT_BAD_ARGS)