Build cost spreadsheet for a KiCad project.
KiCost script, also with Graphical User Interface - GUI, under MIT license for generate part-cost spreadsheets for circuit boards developed with KiCad and others EDAs.
- Free software: MIT license
- Documentation: https://xesscorp.github.io/KiCost.
- Quick start: https://www.youtube.com/watch?v=AeccxROpDfY.
KiCost is powered by the [Kitspace](https://kitspace.org/) PartInfo API. [Partinfo](https://github.com/kitspace/partinfo) hooks into paid-for 3rd party services. If you find KiCost useful please [donate to the Kitspace Open Collective](https://opencollective.com/kitspace). If Kitspace doesn’t receive enough donations then this free service will have to be shut down.
- Easy installation via pip (see on documentation folder).
- Processes the BOM XML file from your KiCad schematic to create a part-cost spreadsheet by scraping the web sites of several popular distributors for price and inventory data. (You can also enter your own quantity-adjusted pricing data for specialized parts or those not found at the supported distributors.);
- Processes also BOM files from Altium, Proteus, Eagle, Upverter and hand made CSVs;
- The spreadsheet contains quantity-adjusted pricing from each distributor for individual parts and the total board;
- Enter the number of boards to be built in a spreadsheet cell and all the pricing for the total board and individual parts is updated;
- The spreadsheet also shows the current inventory on-hand for each part at each distributor;
- Enter the quantity of each part that you want to purchase from each distributor and lists of part numbers and quantities will appear in formats that you can cut-and-paste directly into the website ordering page of each distributor.
- Add TME and Arrow to Kitspace API.
- Others cosmetic and internal changes.
- Fix the Digikey using Digi-Reel information.
- Added LCSC as distributor into the Kitspace API (the list can be used to JLCPCB).
- Parinfo kitspace API now just return the asked distributors (before was given all the avaliable distributors).
- Check by accepted stock code into the API modules.
- Added --info command to get all the details of KiCost installation.
- Now --setup and --unsetup add and remove the default KiCost field to Eeschema template. --setup ran at the KiCost installation.
- Added a NEWS dialog on first GUI initialization.
- Fix in GUI: process bar, the not found module name, Windows open spreadsheet in the GUI and LibreOffice installation check on Windows.
- Fix minimum order number and warning the user, it also show in the price break.
- Improve some spreadsheet formulas.
- Fix the Kitspace query API to prioritize the catalogue number under the manufacture code.
- Added a global field for purchase information, it will be added as description to be printed into the package labels (Digikey and others distributors that allow to include description into the package labels).
- Organized the distributors information for better KiCost next features in the road map.
- Fix the issue of RST files in the PyPI package.
- Use the PartInfo KitSpace API.
- Creates a KiCad plugin integration and desktop shortcuts (not in Mac-OS) during the installation.
- Add KiCost to the context menu “Open with…” in Windows to XML and CSV files.
- Show (and allow to change in the spreadsheet) the current currency rate for distributors that are not in the specified currency.
- Highlight non-active in production / not-recommended-to-new-layout / decrepit components.
- Improved the spreadsheet purchase distributors code formula and fix the Digikey/Mouser import errors.
- Show the total purchased at the spreadsheet.
- Split the GUI file in programming one in wxFormBuilder generated.
- Fix the error when deal with spaces in the names of BOM files on test.sh.
- Use the datasheet information distributor/API as link in manf# if not got any by the BOM.
- Added user warnings of bad manf format in case of multi-files of different quantities assigned on the catalogue codes.
- manf# cell get purple color if the distributor assigned the part as ‘obsolete’ or ‘not recommended for new designs’.
- Fix READ file on installation.
- Fix the *.md installation files.
- Minor modifications into the new class model.
- Complete re-facture of internal class structure, now distributors and edas follow a heritage model.
- Add a post_setup function to configure shortcut and OS dependent settings.
- Fix some minor error with multi file projects.
- Fix the Octopart response with part with manf# but with distributor#.
- Removed the limitation of subpart with empty manf# that doesn’t respected the quantity.
- Re-facture the KiCost motor, now use the Octopart API.
- Added a full currency convert capability.
- Fix some minor error with multi file projects.
- Created the KiCad plugin (in beta).
- Fixed Digikey distributor module logger problem raise on refacture.
- Added GUI compatibility with wxPython 3.x.x.
- Added convert to ODS option if recognized LibreOffice in the system.
- Others GUI controls improvements.
- Fixed some Python 2 incompatibility of the GUI and Altium module.
- Fixed the tqdm print channel. Now the process bar is kept at the end.
- Fixed the output messages when used the GUI.
- Fixed GUI problem caused by distributors re-factore and other UI improvements.
- More improvements on scrape classes.
- Now TME ajax post scrape method repect the fake_browser.
- Changed Farnell link and table result format.
- Fixed TME fake_browser migration.
- Re-factored the distributors modules to class kind and improved the scrape sequence to decrease probability of ban.
- Fixed the multi-threading configuration.
- Fixed Mac-OS hang when parallel scraping.
- Fixed logging messages when using tqdm (process bar) for sequential scrape, missing fix for multithreads scrape.
- Improve the spreadsheet.py to a lighter file when use just one distributor.
- Improved log messages to better community debug.
- Add Upverter CSV compatibility.
- Fixed Mouser “quote price” exception in the price tiers.
- Fixed wxPython exception import.
- Use the datasheet link information from KiCad and other EDAs, given by ‘datasheet’ field.
- Now automatically merge ‘description’ and other fields to create the groups.
- GUI save last position and size and others improvements.
- Display additional information from the web page distributors and use as comment in the cat# column (just implemented on DigiKey yet).
- Now is possible to specify country/currency to be priorized on the distributors scrapes (just implemented on DigiKey yet).
- Minor improvements.
- Fixed RS scrape module.
- Added --no_scrape option to create spreadsheets without information from distributor websites.
- Added --no_collapse option to prevent collapsing part references in the spreadsheet.
- Added --throttling_delay option to add delay between accesses to distributor websites.
- Added --show_eda_list option to display the list of EDA tools supported by KiCost.
- Added capability to read multiple BOM files and merge them into the spreadsheet.
- Added --group_fields option to ignore differences in fields of the components and group them.
- Fixed the not ungrouping issue when manf# equal None.
- CSV now accepts files from Proteus and Eagle EDA tools.
- Cleared up unused Python imports and better placed functions into files (spreadsheet creation files are now in spreadsheet.py).
- Added a KiCost stamp version at the end of the spreadsheet and file information in the beginning, if they are not inside it.
- Fixed issues related to user visualization in the spreadsheet (added gray formatted conditioning and the “exclude desc and manf columns”).
- Added “user errors” and software scape in the case of not recognized references characters given the message of how to solve.
- Support for multiple quantity for a single manufacture code (before just worked when using multiple/sub-parts).
- Fixed the Altium EDA module.
- Created a graphical user interface based on wxWidgets (the dependence is asked to be installed at the first use).
- Added the --user option allow to use just kicost --user -i %file and others parameters will be got by the last configuration in the graphical interface (that save the user configurations).
- Added automatic recognition of the files of each EDA tool (for the graphical interface).
- Processing of CSV files containing part information is now supported.
- Added show_dist_list option to display the list of distributors from which part cost data is available.
- Added capability to process multiple XML and CSV files.
- Fixed exception caused by missing ‘href’ key in product links extracted by TME module.
- Fixed exceptions caused by .xml files without a title block or part library section.
- Part number separator characters can now be escaped with backslashes in case they are actually part of part numbers.
- Fixed webscrape retry error in TME distributor module.
- A part manf# field can now contain multiple subpart numbers. Each part number can be assigned a multiplier to indicate the quantity of the subpart needed for each part.
- Unit price cells for parts now show complete Qty/Price table as a cell comment.
- Part quantity cells are now color-coded to indicate parts with insufficient availability.
- Part quantity cells are now color-coded to indicate parts for which insufficient quantity has been ordered.
- Project name, company, and date are now shown in the spreadsheet.
- New distributor can now be added just by creating a submodule in distributors.
- Added distributor TME.
- Added --retries option to set the number of attempts at loading a distributor webpage.
- Fixed problem where “kicost:dnp” field was not recognized.
- Parts may now be assigned to a variant by giving them a variant field.
- Parts may now be assigned to multiple variants.
- Parts may be designated as “do not populate” by giving them a DNP field.
- DNP parts or parts not in the current variant will not appear in the cost spreadsheet.
- Fixed bug in scraping RS website when a part search results in a list of matches instead of a single product page.
- Fixed crash caused by uninitialized array in Digikey webscraping module.
- Place any available scraped part info into spreadsheet even if part is not available from a distributor.
- Removed unused imports from distributor modules.
- Surround worksheet name with quotes in case it contains spreadsheet operators.
- Fixed extraction of product links from Farnell product tables.
- Added options for including or excluding distributors.
- Updated web scrapers for various distributors.
- Added more debugging/logger statements.
- Updated some of the package requirements.
- Giacinto Luigi Cerone added support for distributors Farnell and RS.
- Manufacturer’s part number field can now be labeled as ‘manf#’, ‘mpn’, ‘pn’, ‘#’, etc. (See documentation.)
- Manufacturer field can now be labeled as ‘manf’ or ‘manufacturer’.
- Distributor part number fields can now be labeled as ‘digikey#’, ‘digikeypn’, digikey_pn’, ‘digikey-pn’, etc.
- KiCost no longer fails if the <libparts>…</libparts> section is missing from the XML file.
- Documentation moved to Github Pages.
- Fixed scraping of Digi-Key pages to correctly detect reeled parts and scrape alternate packaging options.
- Fixed scraping of Digi-Key pages to correctly extract available quantity of parts.
- Progress bar is explicitly deleted to prevent an error from occurring when the program terminates.
- Contents of “Desc” field in component/library were being ignored when generating spreadsheet.
- Fixed part scraping from Newark website.
- Added progress bar.
- Added quiet option to suppress warning messages.
- ‘manf#’ and ‘manf’ fields are now both propagated to similar parts.
- Extra part data can now be shown in the global data section of the spreadsheet by using the new --fields command-line option. This commit implements issue #8.
- Parts with valid Digi-Key web pages were not appearing in the spreadsheet because they had strange quantity listings (e.g., input fields or ‘call for quantities’. This commit fixes #36.
- Prices of $0.00 were appearing in the spreadsheet for parts that were listed but not stocked. Parts having no pricing list no longer list a price in the sheet.
- Parts with short manf. numbers (e.g. 5010) were not found correctly in the distributor websites. The manufacturer name was added to the search string to increase the probability of the search finding the correct part.
- Local parts weren’t showing up in spreadsheet because of previous fix to omit parts that had no quantity field (non-stocked; not even 0). Fixed.
- Made change to adapt to change in Digi-Key’s part quantity field of their webpages.
- Omit parts from the spreadsheet that are listed but not stocked at a distributor.
- Made changes to adapt to changes in Digi-Key’s webpage format.
- Added --variant command-line option for costing different variants of a single schematic.
- Added --num_processes command-line option for setting the number of parallel processes used to scrape part data from the distributor web sites.
- Added --ignore_fields command-line option for ignoring benign fields that might prevent identical parts from being grouped together.
- Fixed exception caused when indexing with ‘manf#’ on components that didn’t have that field defined.
- Replaced custom debug_print() with logging module.
- When scraping a Digi-Key product list page, use both the manfufacturer’s AND Digi-Key’s number to select the closest match to the part number.
- ‘kicost:’ can be prepended to schematic field labels to distinguish them from other app fields.
- Custom prices and documentation links can now be added to parts in the schematic.
- Web-scraping for part data is sped up using parallel processes.
- Following the IP address mouser with redirect you to the nearest locale match, so the price will be in Euro if you are in Europe and the price decimal can be a comma.
- Changed BOARD_COST field to UNIT_COST.
- Changed formatting of UNIT_COST field to make use monetary units.
- Changed format of debug messages.
- Pushed lxml requirement back to 3.3.3 so linux mint would have fewer problems trying to install.
- Fixed exception caused by Digi-Key part with ‘call’ as an entry in a part’s price list.
- Fixed extraction of part quantities in Mouser web pages.
- Added randomly-selected user-agent strings so sites might be less likely to block scraping.
- Added missing requirements for future and lxml packages.
- KiCost now runs under both Python 2.7.6 and 3.4.
- Mouser changed their HTML page format, so I changed their web scraper.
- Corrected entrypoint in __main__.py.
- Added conditional formatting to indicate which distributor had the best price for a particular part.
- Fixed calc of min unit price so it wouldn’t be affected if part rows were sorted.
- Added global part columns that show minimum unit and extended prices for all parts across all distributors.
- To reduce the effort in adding manufacturer’s part numbers to a schematic, one will now be assigned to a part if:
- It doesn’t have one.
- It is identical to another part or parts which do have a manf. part number.
- There are no other identical parts with a different manf. part number than the ones in item #2.
- Fixed delimiter for Mouser online order cut-and-paste.
- First release on PyPI.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size kicost-1.1.4.tar.gz (707.2 kB)||File type Source||Python version None||Upload date||Hashes View|