KiCostOptions parameters
board_qty : Alias for number.
currency : [string | list(string)] (default:
'USD') Currency priority. Use ISO4217 codes (i.e. USD, EUR).distributors : [string | list(string)] (default:
[]) Include this distributors list. Default is all the available.no_distributors : [string | list(string)] (default:
[]) Exclude this distributors list. They are removed after computing distributors.no_price : [boolean] (default:
false) Do not look for components price. For testing purposes.number : [number] (default:
100) Number of boards to build (components multiplier).output : [string] (default:
'%f-%i%I%v.%x') Filename for the output (%i=kicost, %x=xlsx). Affected by global options.aggregate: [Aggregate parameters] [list(dict)] (default:[]) Add components from other projects.dnf_filter: [string | list(string)] (default:'_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.
Don’t use the kicost_variant when using internal variants/filters.exclude_filter: [string | list(string)] (default:'_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.fields: [string | list(string)] (default:[]) [comma separated] List of fields to be added to the global data section.group_fields: [string | list(string)] (default:[]) [comma separated] List of fields that can be different for a group. Parts with differences in these fields are grouped together, but displayed individually.ignore_fields: [string | list(string)] (default:[]) [comma separated] List of fields to be ignored.kicost_config: [string] (default:'') KiCost configuration file. It contains the keys for the different distributors APIs. The regular KiCost config is used when empty.
Important for CI/CD environments: avoid exposing your API secrets! To understand how to achieve this, and also how to make use of the cache please visit the kicost_ci_test repo.kicost_variant: [string] (default:'') Regular expression to match the variant field (KiCost option, not internal variants).no_collapse: [boolean] (default:false) Do not collapse the part references (collapse=R1-R4).pre_transform: [string | list(string)] (default:'_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.show_cat_url: [boolean] (default:false) Include the catalogue links in the catalogue code.split_extra_fields: [string | list(string)] (default:[]) [comma separated] Declare part fields to include in multipart split process.translate_fields: [FieldRename parameters] [list(dict)] (default:[]) Fields to rename (KiCost option, not internal filters).variant: [string] (default:'') Board variant to apply. Don’t use the kicost_variant when using internal variants/filters.