Metadata-Version: 2.1
Name: kicost
Version: 1.0.4
Summary: Build cost spreadsheet for a KiCad project.
Home-page: https://xesscorp.github.io/KiCost
Author: XESS Corporation
Author-email: info@xess.com
License: MIT
Project-URL: Doc, https://xesscorp.github.io/KiCost
Project-URL: Git, https://github.com/xesscorp/KiCost
Keywords: kicost,KiCAD
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4 (>=4.3.2)
Requires-Dist: XlsxWriter (>=0.7.3)
Requires-Dist: future (>=0.15.0)
Requires-Dist: lxml (>=3.7.2)
Requires-Dist: yattag (>=1.5.2)
Requires-Dist: tqdm (>=4.4.0)
Requires-Dist: requests (>=2.18.4)
Requires-Dist: CurrencyConverter (>=0.5)
Requires-Dist: babel (>=2.6)

KiCost
======

[![image](https://img.shields.io/travis/xesscorp/kicost.svg)](https://travis-ci.org/xesscorp/kicost)
[![image](https://img.shields.io/pypi/v/kicost.svg)](https://pypi.python.org/pypi/kicost)

KiCost is intended to be run as a script for generating part-cost
spreadsheets for circuit boards developed with KiCad. KiCost also comes
with a graphical user interface in addition to command line.

-   Free software: MIT license
-   Documentation: <https://xesscorp.github.io/KiCost>.
-   Quick start: <https://www.youtube.com/watch?v=AeccxROpDfY>.

Powered by [![image](logo_octopart.png)](https://octopart.com)

Features
--------

-   Easy installation via pip (see on documentation folder).
-   Processes the BOM XML file from your KiCad schematic to create a
    part-cost spreadsheet by geetting the price and  inventory data
    of several popular distributors web servers. (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.

![image](block_diag.png)
![image](gui.png)


History
=======

1.0.4 (2018-??-??)
--------------
- Use the datasheet information by Octopart 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 asigned the part as 'obsolete' or 'not recommended for new designs'.


1.0.3 (2018-10-06)
---------------
- Fix READ file on installtion.


1.0.2 (2018-10-06)
---------------

- Fix the *.md installation files.
- Minor modifications into the new class model.


1.0.1 (2018-10-05)
---------------

-   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.

1.0.0 (2018-10-03)
---------------

-   Re-facture the KiCost motor, now use the Octopart API.
-   Added a full currency convert capability.
-   Fix some minor error with multi file projects.

0.1.47 (2018-08-16)
-------------------

-   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.

0.1.46 (2018-07-04)
-------------------

-   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`.

0.1.45 (2018-06-12)
-------------------

-   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.

0.1.44 (2018-05-28)
-------------------

-   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.

0.1.43 (2018-03-15)
-------------------

-   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).

0.1.42 (2017-12-07)
-------------------

-   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.

0.1.41 (2017-11-16)
-------------------

-   Fixed exception caused by missing \'href\' key in product links
    extracted by TME module.

0.1.40 (2017-11-02)
-------------------

-   Fixed exceptions caused by .xml files without a title block or part
    library section.

0.1.39 (2017-10-10)
-------------------

-   Part number separator characters can now be escaped with backslashes
    in case they are actually part of part numbers.

0.1.38 (2017-10-09)
-------------------

-   Fixed webscrape retry error in TME distributor module.

0.1.37 (2017-10-09)
-------------------

-   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.

0.1.36 (2017-08-14)
-------------------

-   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.

0.1.35 (2017-04-24)
-------------------

-   Fixed bug in scraping RS website when a part search results in a
    list of matches instead of a single product page.

0.1.34 (2017-03-31)
-------------------

-   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.

0.1.33 (2017-02-23)
-------------------

-   Surround worksheet name with quotes in case it contains spreadsheet
    operators.
-   Fixed extraction of product links from Farnell product tables.

0.1.32 (2017-02-14)
-------------------

-   Added options for including or excluding distributors.
-   Updated web scrapers for various distributors.
-   Added more debugging/logger statements.
-   Updated some of the package requirements.

0.1.31 (2016-11-14)
-------------------

-   Giacinto Luigi Cerone added support for distributors Farnell and RS.

0.1.30 (2016-11-07)
-------------------

-   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.

0.1.29 (2016-08-27)
-------------------

-   KiCost no longer fails if the \<libparts\>\...\</libparts\> section
    is missing from the XML file.
-   Documentation moved to Github Pages.

0.1.28 (2016-08-18)
-------------------

-   Fixed scraping of Digi-Key pages to correctly detect reeled parts
    and scrape alternate packaging options.

0.1.27 (2016-07-26)
-------------------

-   Fixed scraping of Digi-Key pages to correctly extract available
    quantity of parts.

0.1.26 (2016-07-25)
-------------------

-   Progress bar is explicitly deleted to prevent an error from
    occurring when the program terminates.

0.1.25 (2016-06-12)
-------------------

-   Contents of \"Desc\" field in component/library were being ignored
    when generating spreadsheet.

0.1.24 (2016-05-28)
-------------------

-   Fixed part scraping from Newark website.

0.1.23 (2016-04-12)
-------------------

-   Added progress bar.
-   Added quiet option to suppress warning messages.
-   \'manf\#\' and \'manf\' fields are now both propagated to similar
    parts.

0.1.22 (2016-04-08)
-------------------

-   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.

0.1.21 (2016-03-20)
-------------------

-   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.

0.1.20 (2016-03-20)
-------------------

-   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.

0.1.19 (2016-02-12)
-------------------

-   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.

0.1.18 (2016-02-10)
-------------------

-   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.

0.1.17 (2016-02-09)
-------------------

-   Made changes to adapt to changes in Digi-Key\'s webpage format.

0.1.16 (2016-01-26)
-------------------

-   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.

0.1.15 (2016-01-10)
-------------------

-   Fixed exception caused when indexing with \'manf\#\' on components
    that didn\'t have that field defined.
-   Replaced custom debug\_print() with logging module.

0.1.14 (2015-12-31)
-------------------

-   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.

0.1.13 (2015-12-29)
-------------------

-   \'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.

0.1.12 (2015-12-03)
-------------------

-   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.

0.1.11 (2015-12-02)
-------------------

-   Changed BOARD\_COST field to UNIT\_COST.
-   Changed formatting of UNIT\_COST field to make use monetary units.
-   Changed format of debug messages.

0.1.10 (2015-10-08)
-------------------

-   Pushed lxml requirement back to 3.3.3 so linux mint would have fewer
    problems trying to install.

0.1.9 (2015-09-26)
------------------

-   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 ghost.py code for getting around Javascript challenge pages
    (currently inactive).

0.1.8 (2015-09-17)
------------------

-   Added missing requirements for future and lxml packages.

0.1.7 (2015-08-26)
------------------

-   KiCost now runs under both Python 2.7.6 and 3.4.

0.1.6 (2015-08-26)
------------------

-   Mouser changed their HTML page format, so I changed their web
    scraper.

0.1.5 (2015-07-25)
------------------

-   Corrected entrypoint in `__main__.py`.

0.1.4 (2015-07-09)
------------------

-   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.

0.1.3 (2015-07-07)
------------------

-   Added global part columns that show minimum unit and extended prices
    for all parts across all distributors.

0.1.2 (2015-07-04)
------------------

-   Refactoring.
-   To reduce the effort in adding manufacturer\'s part numbers to a
    schematic, one will now be assigned to a part if:
    1.  It doesn\'t have one.
    2.  It is identical to another part or parts which do have a manf.
        part number.
    3.  There are no other identical parts with a different manf. part
        number than the ones in item \#2.

0.1.1 (2015-07-02)
------------------

-   Fixed delimiter for Mouser online order cut-and-paste.

0.1.0 (2015-06-30)
------------------

-   First release on PyPI.


