schrodingersgat / kibom Goto Github PK

I've received the error below with KiBOM on several installations. If I go in and comment out line 207 in the related module and then add missing items to the .ini file that is generated, I can ultimately get KiBOM to work.
This error below resulted from running KiBOM within KiCAD with the following command line specified:

python "/home/brian/Documents/KiCAD/KiBoM-master/KiBOM_CLI.py" "%I" "%O.html"

Has anyone else had this problem?

Could this be related to "Minor Fix #29"?

Thanks, Brian

Result is below:
------ include -------
Run command:
python "/home/brian/Documents/KiCAD/KiBoM-master/KiBOM_CLI.py" "/home/brian/Documents/KiCAD/Micro_Regulator_1/MicroRegulator1/MicroRegulator1.xml" "/home/brian/Documents/KiCAD/Micro_Regulator_1/MicroRegulator1/MicroRegulator1.html"

Command error. Return code 1
Info messages:
PCB variant: default

Error messages:
Traceback (most recent call last):
File "/home/brian/Documents/KiCAD/KiBoM-master/KiBOM_CLI.py", line 202, in
result = writeVariant(variant, args)
File "/home/brian/Documents/KiCAD/KiBoM-master/KiBOM_CLI.py", line 76, in writeVariant
pref.Write(config_file)
File "/home/brian/Documents/KiCAD/KiBoM-master/bomlib/preferences.py", line 207, in Write
self.addOption(cf, self.OPT_INCLUDE_VERSION, self.includeVersionNumber, comment="If '{opt}' option is set to 1, the schematic version number will be appended to the filename.")
AttributeError: BomPref instance has no attribute 'OPT_INCLUDE_VERSION'

I have a bom.ni local file where:

; Field name used to determine if a particular part is to be fitted
fit_field = FIT

then to test KiBoM I edited a capacitor (C4) on the schematic adding the FIT field filled with:
"+a,-b"

this is my command as typed in Kicad:
python "C:\Dati\Kicad\scripts\KiBoM-master/KiBOM_CLI.py" "-r b" "%I" "%O.html"

on the html file I would expect to don't see C4 listed, instead it is listed and the field on the FIT column contains "+a,-b"

this is my command as typed in Kicad:
python "C:\Dati\Kicad\scripts\KiBoM-master/KiBOM_CLI.py" "-r a" "%I" "%O.html"

on the html file I would expect to see C4 listed, it is listed and the field on the FIT column contains "+a,-b"

In general terms I would expect a different behaviour:
if -r present on the command row: in FIT only fields containing - and + will be considered and the output will be produced with or without them only reporting texts not containing - and + (for instance dnf), if all the fileds will be empty or no dnf (And similar) texts are not found the column will not br printed
if -r not present on the command row: only reporting texts not containing - and + (for instance dnf) if all the fileds will be empty or no dnf (And similar) texts are not found the column will not br printed

The documentation says this section (as others) are case-insensitive.
The code does some effort, but is not enough.

• Configuration example: tests/config_samples/column_sensitive.ini
• Test netlist: tests/input_samples/links.xml

Columns generated in the CSV:

references,value,part,description,Description,Part,References,Value

But we should get:

references,value,part,description

The patch to fix it isn' t trivial. A working solution is on the following branch: fix_column_case

And was merged into my fork as PR #10

I'm not submitting a PR because it will collide with other PRs I submitted. I can submit it after they are merged.

I upgraded my KiCAD to version 5.1.7 today and I noticed that KiBOM_CLI crashes:

Run command:
python “/Users/stevenslupsky/kicad/KiBoM/KiBOM_CLI.py” “-dbom” “/Users/stevenslupsky/Library/Mobile Documents/com~apple~CloudDocs/Kicad/PB_16/Receiver_Out/Receiver_Out.xml” “/Users/stevenslupsky/Library/Mobile Documents/com~apple~CloudDocs/Kicad/PB_16/Receiver_Out/Receiver_Out.xls”

Command error. Return code 1
Info messages:
 KiBOM version 1.8.0
 Output directory: ‘/Users/stevenslupsky/Library/Mobile Documents/com~apple~CloudDocs/Kicad/PB_16/Receiver_Out/bom’
 Input: /Users/stevenslupsky/Library/Mobile Documents/com~apple~CloudDocs/Kicad/PB_16/Receiver_Out/Receiver_Out.xml
 Configuration file: /Users/stevenslupsky/Library/Mobile Documents/com~apple~CloudDocs/Kicad/PB_16/Receiver_Out/bom.ini
 PCB variant: [u’default’]

Error messages:
Traceback (most recent call last):
  File “/Users/stevenslupsky/kicad/KiBoM/KiBOM_CLI.py”, line 28, in <module>
    main()
  File “/Users/stevenslupsky/kicad/KiBoM/kibom/__main__.py”, line 194, in main
    result = writeVariant(input_file, output_dir, output_file, variant, pref)
  File “/Users/stevenslupsky/kicad/KiBoM/kibom/__main__.py”, line 55, in writeVariant
    groups = net.groupComponents(components)
  File “/Users/stevenslupsky/kicad/KiBoM/kibom/netlist_reader.py”, line 357, in groupComponents
    g.updateFields(self.prefs.useAlt)
  File “/Users/stevenslupsky/kicad/KiBoM/kibom/component.py”, line 614, in updateFields
    self.fields[ColumnList.COL_DESCRIPTION] = self.components[0].getDescription()
  File “/Users/stevenslupsky/kicad/KiBoM/kibom/component.py”, line 199, in getDescription
    raise AttributeError(‘Could not get description for part {}{}.’.format(self.getPrefix()),
IndexError: tuple index out of range

I tried it for csv, html or xls output and observed the same result.

I am not sure if the upgrade did this or something else is broken.

I am using the latest version of KiBoM (master branch as of today) with KiCAD v5.1.6 on Ubuntu 18.04.

I am invoking KiBoM using the KiCAD GUI. The first time (when no bom.ini is present) it works fine. However when I click Generate a second time it fails with the following error (I have made no bom.ini modifications):

Error messages:
Traceback (most recent call last):
  File "/home/ghunter/repos/kibom/KiBOM_CLI.py", line 28, in <module>
    main()
  File "/home/ghunter/repos/kibom/kibom/__main__.py", line 175, in main
    pref.Read(config_file)
  File "/home/ghunter/repos/kibom/kibom/preferences.py", line 147, in Read
    fallback=self.outputFileName)
TypeError: get() got an unexpected keyword argument 'fallback'

Is it possible to add a sheetpath column to the BOM? This could be useful for a cost analysis on individual circuits/sheets in your design.

The column would contain the sheetpath that is displayed at the bottom right of every sheet (see picture below).

I'm not sure about the following behavior:

This disables the grouping mechanism, this is OK. But the side effect is that multi-part components will be repeated (as many times as sub-parts). I this the code should be:

if len(self.prefs.groups) == 0: 
    return self.getRef() == other.getRef()

So we don't get the same ref multiple times.

I'm using PIP version 1.7.0 on linux. I found two issues:

1. I specified fit_field = VariantPCB. When I generate BOM files and this parameter is:

• compleatly empty - Quantity = 1 - that's ok
• any character inside, it could be anything: "" or - or a - Quantity = 1(DNC)
• DNF - Quantity = 1(DNF)(DNC)
• parameters of PCB variants doesn't work too. "-VAR1" or "+VAR2" gives Quantity = 1(DNC)

2. In PIP version doesn't work putting output files to specified folder (command line -d BOM). Files are generated correctly (in my test project: temp_BOM_rev.85_2.html), there is generated new folder, with name temp.html, which is empty. There's no folder "BOM".
   In previous version, clon from github it was working fine.

One more thing about linux version of KiCad. There is no possibility to add only the command line in BOM script. Program needs to get file, and then gives access to edit and run " python3 -m kibom "%I" "%O" ".
I override this by creating a new .py file:

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
@package

KiBOM - Bill of Materials generation for KiCad

Command line:
	python3 -m kibom "%I" "%O.csv" -s ; -d BOM -n 1 -r default

	"%O" - output format
		- "%O.csv"
		- "%O.html"

	-s - column separator
	-d - output subdirectory
	-n - number of PCB to calculate
	-r - variant of PCB 
"""
print("\n\nTO GENERATE OUTPUT FILES USE COMMAND LINE FROM DESCRIPTION")

My test command line:
python3 -m kibom "%I" "%O.html" -s ; -d BOM -n 1

Regards

In some languages date field can contain unicode characters and it crushes while parsing date.
To fix that I've did:

def getDate(self):
    """Return the date + time string generated by the tree creation tool"""
    return self.design.get("date").encode('ascii', 'ignore')

Importing csv/tsv files in libreoffice correctly requires that you set the type of each column manually.
Otherwise texts like the footprint "0805" will be imported as a number and turned into 805.

It would be helpful to have Kibom wrap fields in quotes to allow import into libreoffice with the "import quoted fields as text" feature.

Naturaly those field that do contain numeric data like the Qty and Build Quantity should not get quotes.

When I first tried it on Ubuntu, KiCad 4.0.2, the KiCad BOM dialog generated a command line for me without a suffix on the output file name i.e. "%O". Then when you choose Generate button, it says it succeeded (the app returns 0, it should return -1) but there was no file generated and there was a message that the extension was not supported.

I think that the code should append a suffix if any passed suffix is not supported. My reasoning is that for nieve users who don't know to change the command line, the program should do something reasonable.

I have forked and fixed and will submit a pull request. Of course you can reject it.

BTW, thanks very much, I appreciate the lack of dependency on other Python packages and the feature set is just what I need for my use case: generating a BOM to submit to a vendor, grouped appropriately.

Virtual footprints should be ignored by default. I suggest a flag (-a) to show all.
For example, I have a footprint that is a logo. It should not be on BOM because I don't need to by a logo :)

I tried uploading my bom.csv to Digikey using their "BOM Manager" web app. My file included leading white space in my "Digikey Part Number" (or "SKU") column (my bad, probably faulty cut-and-paste from Digikey catalog to KiCad) and Digikey failed to find a match. So the request is: eliminate leading whitespace on values.

I would have thought Digikey would ignore it. In the Digikey app, one can easily delete the whitespace and find a match, its not a big problem.

I might have a chance to fix the issue before ordering my next board.

Per https://github.com/KiCad/kicad-source-mirror/blob/master/scripts/bom-in-python/README-bom.txt
a string comment at the beginning of a plugin gives info that the KiCad BOM dialog will display.

As discussed, for example, here, KiBoM can sometimes fail with UnicodeEncodeError: ‘ascii’ codec can’t encode character if Unicode characters exist in the schematic's component fields.

The issue can be manually worked around by replacing common Unicode characters in schematics like "µ" (\xb5) with "u". But Unicode characters seem to creep into even the plainest of schematics these days, with auto populated fields from manufacturers like "Würth Electronics" (\xfc), and DigiKey descriptions like "±20ppm" (\xb1). So I still see this error a lot.

In this issue, the offending line of code is:

File “/path/to/KiBoM/bomlib/component.py”, line 515, in updateField
    fld=fieldData))

which is only executed if there are Field Conflicts.

At some point in the Nightly builds of KiCAD, something changed that seems to have broken KiBoM. I was getting ConfigParser.NoOptionErrors in two places.

I was able to work around the issue (in an inelegant way) by changing lines 143-144 preferences.py in bomlib to:

        self.outputFileName = "bom"
        self.variantFileNameFormat = "csv"

Hi there!

I have several parts that I want to include in my BOM but those parts contains words in their footprints or in their library names that makes them excluded.
Example:
Test points:
my_library:TP_SMD_5019
Connectors:
my_library:DSUB-9_Female_Horizontal_P2.74x2.54mm_EdgePinOffset10.07mm_Housed_MountingHolesOffset11mm
Connector_Phoenix_MC:PhoenixContact_MC_1,5_3-GF-3.5_1x03_P3.50mm_Horizontal_ThreadedFlange_MountHole

Anyting that contains the words "test point" or "mount hole" is excluded and it seems that there is no option to bypass that.

In my case, I use a field caled "Part Number" with the device part number.
Is there any chance to force any device that contains a value in the field "Part Number" to be included in the BOM?

Best regards,
Cristiano Rodrigues

While testinng the code I found that:

Is using:
GREEK SMALL LETTER MU U+03BC GREEK SMALL LETTER MU μ

But, at least for me, is more common to use:
MICRO SIGN U+00B5 MICRO SIGN µ

So I'm using:

REFIX_MICRO = [u"μ", u"µ", "u", "micro"]

Which looks pretty lame, and I hope the cut & paste worked ;-), but includes both: the micro sign and the greek letter.

Stumbled on your repo and am excited with what I've found so far, but have one request:

Can you add a license so I can understand how I can use it?

I might suggest MIT license if you want to be openly permissive, quick overview at tl;dr legal

Thanks!

I'm getting an exception when running KiBoM, using the +<VARIANT> and -<VARIANT> syntax
in the config field:

KiBOM version 1.7.1
 Output directory: '/home/michael/kicad/Marble-Mini'
 Input: /home/michael/kicad/Marble-Mini/AMC_FMC_Carrier-PcbDoc.xml
 Configuration file: /home/michael/kicad/Marble-Mini/bom.ini
 PCB variant: standalone
Traceback (most recent call last):
  File "/usr/lib/python3.8/pdb.py", line 1701, in main
    pdb._runmodule(mainpyfile)
  File "/usr/lib/python3.8/pdb.py", line 1546, in _runmodule
    self.run(code)
  File "/usr/lib/python3.8/bdb.py", line 580, in run
    exec(cmd, globals, locals)
  File "/home/michael/kicad/KiBoM/kibom/__main__.py", line 3, in <module>
    """
  File "/home/michael/kicad/KiBoM/kibom/__main__.py", line 189, in main
    result = writeVariant(input_file, output_dir, output_file, variant, pref)
  File "/home/michael/kicad/KiBoM/kibom/__main__.py", line 54, in writeVariant
    groups = net.groupComponents(components)
  File "/home/michael/kicad/KiBoM/kibom/netlist_reader.py", line 344, in groupComponents
    if g.matchComponent(c):
  File "/home/michael/kicad/KiBoM/kibom/component.py", line 503, in matchComponent
    if c == self.components[0]:
  File "/home/michael/kicad/KiBoM/kibom/component.py", line 117, in __eq__
    if self.isFixed() != other.isFixed():
  File "/home/michael/kicad/KiBoM/kibom/component.py", line 354, in isFixed
    if opt[1:].lower() == self.prefs.pcbConfig.lower():
AttributeError: 'list' object has no attribute 'lower'
Uncaught exception. Entering post mortem debugging

this patch fixes it

diff --git a/kibom/component.py b/kibom/component.py
index 2eef873..0943855 100644
--- a/kibom/component.py
+++ b/kibom/component.py
@@ -346,12 +346,12 @@ class Component():
 
         for opt in opts:
             # Options that start with '-' are explicitly removed from certain configurations
-            if opt.startswith('-') and opt[1:].lower() == self.prefs.pcbConfig.lower():
+            if opt.startswith('-') and opt[1:].lower() in self.prefs.pcbConfig:
                 result = False
                 break
             if opt.startswith("+"):
                 result = False
-                if opt[1:].lower() == self.prefs.pcbConfig.lower():
+                if opt[1:].lower() in self.prefs.pcbConfig:
                     result = True
 
         # by default, part is not fixed

I cannot get the group_connectors option in the bom.ini to work.
As I understand it "value" field is ignored for components who is of type "connector".
I don't know the exact mechanism, but trying to search for the group_connectors option ended in the preferences.py file.
Also if I look in your example schematic you have 2 connectors (P1 and P2), and they are having separate lines in your example .html and .csv output files.
Do you have to give connectors a special field to mark them as "connectors"??

I have a Field named Mouser and other MOUSER
It only outputs the Mouser fields and the other does not appear.

My schematic is organized by manufacturer (manf) and manufacturer part number (panf_pn) fields. Also we are using the Config field for multiple configurations (-no_batt, -no_12V, -no_5V)
Occasionally we have a part (example resistor Manf = Yageo, Manf_PN= 08051k) that is used in multiple places and has multiple configs. Some update in the last year now prevents parts with 'conflicted_field' to no longer be printed to the BOM. Anyway to fix this?
Thanks!

the readme for installing kibom in windows is unclear

the readme still mentions KiBOM_CLI.py in the quick start section

trying to use the 2.7 python from kicad appears not to work
C:\Program Files\KiCad\bin>pip install kibom
works
however
python -m kibom "%I" "%O"
in the BOM window gets
Error messages: Traceback (most recent call last): File "C:\Program Files\KiCad\lib\python2.7/runpy.py", line 174, in _run_module_as_main "__main__", fname, loader, pkg_name) File "C:\Program Files\KiCad\lib\python2.7/runpy.py", line 72, in _run_code exec code in run_globals File "C:\Program Files\KiCad\lib\python2.7\site-packages\kibom/__main__.py", line 198, in <module> main() File "C:\Program Files\KiCad\lib\python2.7\site-packages\kibom/__main__.py", line 170, in main pref.Read(config_file) File "C:\Program Files\KiCad\lib\python2.7\site-packages/kibom/preferences.py", line 143, in Read self.outputFileName = cf.get(self.SECTION_GENERAL, self.OPT_OUTPUT_FILE_NAME) File "C:\Program Files\KiCad\lib\python2.7/ConfigParser.py", line 340, in get raise NoOptionError(option, section) ConfigParser.NoOptionError: No option u'output_file_name' in section: u'BOM_OPTIONS'

trying with a separate install of python3 gets (with paths removed)

Requirement already satisfied: kibom in c:\users\fireblade\appdata\local\programs\python\python38-32\lib\site-packages (1.7.1)
Requirement already satisfied: xlsxwriter in c:\users\fireblade\appdata\local\programs\python\python38-32\lib\site-packages (from kibom) (1.2.9)

C:\Users\fireblade>python -m kibom "<inpath>" "<outpath>"
 KiBOM version 1.7.1
 Output directory: '<outpath>'
 Input: <inpath>
Traceback (most recent call last):
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\configparser.py", line 789, in get
    value = d[option]
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\collections\__init__.py", line 898, in __getitem__
    return self.__missing__(key)            # support subclasses that define __missing__
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\collections\__init__.py", line 890, in __missing__
    raise KeyError(key)
KeyError: 'output_file_name'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\runpy.py", line 194, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\site-packages\kibom\__main__.py", line 198, in <module>
    main()
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\site-packages\kibom\__main__.py", line 170, in main
    pref.Read(config_file)
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\site-packages\kibom\preferences.py", line 143, in Read
    self.outputFileName = cf.get(self.SECTION_GENERAL, self.OPT_OUTPUT_FILE_NAME)
  File "C:\Users\fireblade\AppData\Local\Programs\Python\Python38-32\lib\configparser.py", line 792, in get
    raise NoOptionError(option, section)
configparser.NoOptionError: No option 'output_file_name' in section: 'BOM_OPTIONS'```

pip show KiBOM

Name: kibom
Version: 1.7.1
Summary: Bill of Materials generation tool for KiCad EDA
Home-page: https://github.com/SchrodingersGat/KiBom
Author: Oliver Walters
Author-email: [email protected]
License: MIT
Location: /usr/local/lib/python3.7/dist-packages
Requires: xlsxwriter
Required-by:

ls /usr/local/lib/python3.7/dist-packages/kibom

bom_writer.py csv_writer.py init.py preferences.py units.py xml_writer.py
columns.py debug.py main.py pycache version.py
component.py html_writer.py netlist_reader.py sort.py xlsx_writer.py

kiBOM_CLI.py is missing
Manually downloading the tar.gz shows also that this file is missing

I'm trying to set up kibom for the first time. I want to run it from within kicad Bill of Material window. The first issue I ran into is that, contrary to readme, I could not find any file "KiBOM_CLI.py". So instead I selected main.py when adding the kibom plugin.

When I run python "/Users/user1/Library/Preferences/kicad/scripting/KiBoM/kibom/__main__.py" "%I" "%O" I get Command error. Return code 1 Error messages: Traceback (most recent call last): File “/Users/peer/Library/Preferences/kicad/scripting/KiBoM/kibom/__main__.py”, line 26, in <module> from .columns import ColumnList ValueError: Attempted relative import in non-package and no output

If I instead add the plugin by selecting init.py and running "/Users/peer/Library/Preferences/kicad/scripting/KiBoM/kibom/__init__.py" "%I" "%O I see a success message and eeschema xml netlist created in project directory.

Please help me set up KiBoM.

It would be great to be able to specify the specific order of the columns from the bom.ini file.

Currently they tend to end up in an unsuitable order, and have to be manually rearranged every time the BOM is generated.

Using KiBoM_CLI from within KiCad can't output xlsx :
python "F:\programmes\KiCad\bin\scripting\plugins\KiBoM/KiBOM_CLI.py" "%I" "%O.xlsx"

Log :
ERROR Error writing XLSX output
ERROR Error writing variant 'None'

I'm on windows 10, I have installed XlsxWriter and I have no issue with other output formats.

There seems to be a bug in the "exclude-from-variant" feature. Any part with the - prefix in the fit_field is ignored, regardless of the variant configuration passed.

Here's an example of the issue:

With no variant flag, only C1 appears. With the option -r foo passed, C1 and C3 appear.
From the readme, I'd expect C1 and C2 to appear with no flag passed, right?

I'm running Manjaro Linux with KiCAD 5.1.0, Python 2.7.16, and the latest version of KiBOM as of writing (e4df1e8). I've also attached the example project I used to test this. test-project.zip

For boards where there are many identical components, it would be good to have the option to group references together like KiField does.

For example instead of:

R1, R4, R5, R6, R7, R8, R9, R10

you could have:

R1, R4-R10

I have 4 parts without a footprint, but with a field, I called MPN (manufacturer part number).
How can I include them on the BOM?

Hi,

I'm trying to run KiBom from the command line with no GUI interaction at all. I noticed that in projects where I haven't run the BOM from the GUI, there's no xml netlist (at least on windows with Kicad 5.1.4).

Is there a way to generate that netlist so I can run KiBom from the command line? The alternative I see is runing the BoM at least once from the GUI, but that's prone to errors as it would be very easy to forget to update the XML if something changes in the schematic, and you would be generating an outdated BoM

It would be nice if this program could be packaged so that users could install it just by using easy_install, pip or other packaging tools.

Hi,

i'm trying to group different values into one group (aka one line).
Our primary grouping indicator is a field called "InternalName", which must be unique in the exported BOM.

This works, but when the only difference are the values, e.g. 10k/30mW and 10/50mW, only one of them appears in the 'Value' column. Is it possible, that they are all listed?

As a reference, here is our ini-file:
bom2.ini.zip

kind regards, Karl

Any string entered in the "not_fitted" field is marked as (DNF)

Script string:
python "C:\Program Files\KiCad\bin\plugins\KiBoM-master\KiBOM_CLI.py" "%I" "%O_BOM.html"

bom.ini:

ignore_dnf = 0
fit_field = Fitted
board_variant = default

Output generated:

KiCAD: (5.1.2)-1, release build, on Windows 10 64-bit

Update:
I get the same results in Ubuntu 19.04 with Kicad 5.1.2-f72e74a84ubuntu19.04.1, release build

Hi,

First of all, thanks for this tool. I haven't used it yet, but looks perfect for my needs.

While reading the documentation, I've seen the --revision parameter and I find it misleading. Revision to me, means version, as in v3, v4.1, rev2 or something like that. Also configuration is used in some places for this, which is a bit better but I think the industry standard for this is variant which in fact is the word you use in the help to explain it.

If you wanted to use the word variant instead, I can provide a PR. At least for the docs, don't know if you would want to change the API too (or anything at all).

Thanks!

Create an example schematic file, and ensure that the KiBoM script functions as desired.

This testing process should also calculate code coverage.

The generated "ini" file contains the two lines: hide_headers = False and hide_pcb_info = False, however, setting the values to "True" does not work. I.e hide_pcb_info = True does not work.

The new preferences hideHeaders and hidePcbInfo are described in the example config file in the README as such. To get them to work I had to use the keywords hide_headers and hide_pcb_info instead.

This appeared to happen here: 08b2338

Just updated to the most recent version. Unfortunately, it creates a .csv output as follows with the strings wrapped in b'...':

Component,Description,Part,References,Value,Footprint,Quantity Per PCB,Datasheet,Manufacturer,PartNumber,Remarks,Alternative,Config,DNP,Supplier
1,b'Unpolarized capacitor',b'C',b'C9 C10 C16 C19 C24 C25 C26 C30 C31 C32 C34 C39 C42',b'100n',b'C_0603_1608',b'13',b'',b'Yageo',b'CC0603KRX7R9BB104',b'',b'',b'',b'',b''

Using Python 3.7.0 on Linux.

Even with a schematic that has only a single resistor from the standard library I get the following error.
KiCad is version 4.0.7 running under Windows 10, with the KiBOM version I downloaded on 30th August 2018.

Did I miss something or is this a real bug?

Thanks for the help

KiBOM Output from Bill of Material Window in KiCad

Run command:
python "C:/_owncloud/Documents/KiCad/KiBoM-master/KiBOM_CLI.py" "C:/_owncloud/Documents/KiCad/_dummy2/dummy.xml" "C:/_owncloud/Documents/KiCad/_dummy2/dummy"

Command error. Return code 1

Error messages:
Traceback (most recent call last):
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/KiBOM_CLI.py", line 124, in <module>
    groups = net.groupComponents(components)
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/bomlib/netlist_reader.py", line 422, in groupComponents
    g.updateFields(self.prefs.useAlt, self.prefs.altWrap)
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/bomlib/component.py", line 471, in updateFields
    self.fields[ColumnList.COL_DESCRIPTION] = self.components[0].getDescription()
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/bomlib/component.py", line 127, in getDescription
    return self.element.get("libsource", "description")
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/bomlib/netlist_reader.py", line 190, in get
    ret = child.get(elemName, attribute, attrmatch)
  File "C:/_owncloud/Documents/KiCad/KiBoM-master/bomlib/netlist_reader.py", line 183, in get
    return self.attributes[attribute]
KeyError: 'description'

And here the xml file

<?xml version="1.0" encoding="UTF-8"?>
<export version="D">
  <design>
    <source>C:/_owncloud/Documents/KiCad/_dummy2/dummy.sch</source>
    <date>31/08/2018 08:43:49</date>
    <tool>Eeschema 4.0.7</tool>
    <sheet number="1" name="/" tstamps="/">
      <title_block>
        <title/>
        <company/>
        <rev/>
        <date/>
        <source>dummy.sch</source>
        <comment number="1" value=""/>
        <comment number="2" value=""/>
        <comment number="3" value=""/>
        <comment number="4" value=""/>
      </title_block>
    </sheet>
  </design>
  <components>
    <comp ref="R2">
      <value>330R</value>
      <footprint>Resistors_SMD:R_1206</footprint>
      <libsource lib="device" part="R"/>
      <sheetpath names="/" tstamps="/"/>
      <tstamp>5B88D4F0</tstamp>
    </comp>
  </components>
  <libparts>
    <libpart lib="device" part="R">
      <description>Resistor</description>
      <footprints>
        <fp>R_*</fp>
        <fp>R_*</fp>
      </footprints>
      <fields>
        <field name="Reference">R</field>
        <field name="Value">R</field>
      </fields>
      <pins>
        <pin num="1" name="~" type="passive"/>
        <pin num="2" name="~" type="passive"/>
      </pins>
    </libpart>
  </libparts>
  <libraries>
    <library logical="device">
      <uri>C:\Program Files\KiCad\share\kicad\library\device.lib</uri>
    </library>
  </libraries>
  <nets>
    <net code="1" name="Net-(R2-Pad1)">
      <node ref="R2" pin="1"/>
      <node ref="R2" pin="2"/>
    </net>
  </nets>
</export>

I don't get the idea of this option.
It introduces \n characters in the "References" column, this isn't a good idea for most formats:

• HTML/XML: white spaces are equivalent, no difference between ' ' and '\n'
• CSV: the \n isn't escaped and the row is cut. OpenOffice supports it, but I wonder if simpler programs can interpret it. Any program reading line by line will break.
• XLSX: in this case you have better options, like make the cell adjust to text.

In any case the documentation should state which formats are supposed to suport it and the fact that it only works with "use_alt = 1"

The current logic is:

I don't get it. If the idea is to loosly group fields: should't we be doing a return True?
I mean:

 if this_field == "" or other_field == "": 
     if self.prefs.mergeBlankFields: 
         return True

Note that even when the condition seems to be equivalent it isn't.
In this version of the code we have a chance to return True, in the other don't.

Hello,
First, thank you and congratulation for your great work !

I use Kibom on Ubuntu (16.04) and Python 2.7.

I'm not able to use -d argument to create the bom file in a specific
project folder.
I use the command : python -m kibom -d bom "%I" "%O.csv"
The directory name is "bom".

I installed version with pip.
I tried also latest version 1.7.1pre but there is same problem.
Thank you very much again !

Frex

Hi,
I'm trying to add KiBoM a new feature: define new fields whose values will be database queries.
Right now, I added a [DATABASE] section to the config file, and a database.py new file to handle all the related function.
I am able to connect and disconect to the database, and now, I'm trying to define a new field for a component, but I can't understand how to do this...

In KiBoM_CLI.py, I understand that this new code should go after:

# Read out the netlist
net = netlist(input_file, prefs=pref)

# Extract the components
components = net.getInterestingComponents()

I would like to insert a new field with its value for each component. How could I do it?

Thanks,

The ohm detection is wrong:

We always apply lower() so we never really get uppercase omega.
This is the correct list:

UNIT_R = ["r", "ohms", "ohm", u'\u03c9']

BTW, I found that an uncommon unicode that we also support is:

'OHM SIGN' (U+2126)
SI unit of resistance, named after G. S. Ohm, German physicist preferred representation is U+03A9

The lowercase is the same for:

'GREEK CAPITAL LETTER OMEGA' (U+03A9)

So the above code covers both.

When submitting csv to Digikey, in the Description (or Value?) column I had text having a comma. In the csv, the whole text was quoted. Digikey seems to recognize the quoted comma as a column separator. I don't know enough about the csv specification to know where the issue belongs, but probably with Digikey, and you should dismiss this issue as a hint to users not to use commas in their fields.

Thanks again.

In custom atomic parts libraries, some components have a value that includes the '/' character. In this case, KiBoM has difficulty in finding the description of many components included in the same files (.lib and .dcm), even if the component value do not have a '/'.

Faulty librairies are easily find using grep:
$ grep 'F1 "' *.lib | grep '/'
$ linear_voltage_regulator.lib:F1 "SPX1117M3-L-3-3/TR" -600 -375 50 H I L TNN
$ linear_voltage_regulator.lib:F1 "SPX1117M3-L/TR" -605 -505 50 H I L TNN
$ thermistor_ptc.lib:F1 "MF-MSMF110/16-2" -750 -475 50 H I L TNN

This limitation was not in the KiBoM master branch in October 2018... or it can be relative to software upgrade on my side. In october, I was running on MX Linux 17.1 with KiCad 4.0.7 and Python 2.7

Presently, I'm running MX Linux 18.2 with KiCAD 5.0.1, Python 3.7.0, and the latest version of KiBOM as of writing (e4df1e8)

I want to export a BOM, where an internal part number is a primary key (unique) in the exported list.

But test points, which all have the same part number (NAP), are grouped into 2 different rows:

Part        | Part Lib    | References                      | Value       | Footprint                | Footprint Lib | Quantity Per PCB | InternalName
Montageloch | t14_mech    | MH301 P1601 S301 TP305-TP306... | Montageloch | MH_DK_M3_4mm-DSD-special | t14_mech      | 16               | NAP
Testpunkt   | t14_mech    | TP301-TP304 TP307-TP308         | +5V         | LSP13                    | dsd-cc-eagle  | 6 (DNF)          | NAP

Can this "feature" be turned off?