KiABOM documentation

KiABOM is an automatic Bill Of Materials (BOM) generator script used to extract component information from a KiCad schematic, and use that information with KiCost to get part details from suppliers like the price, manufacturer, order-code, stock, and more. The currently supported suppliers are Mouser and Digikey.

Contents:

• Installation
  • Executable Installation
    • Windows
      • Automatic Installation
      • Manual Installation
    • Linux
    • macOS
  • Python Installation
    • Windows
    • Linux
    • macOS
• Usage
  • Using Through a Terminal
  • Using Through KiCad
    • Via Legacy BOM Generator
    • Via Netlist Exporter
    • Via a Jobsets File
  • Using With Supplier BOM Tools
  • Advanced Customisations
    • Adding User Custom Presets
  • Options
    • Example Uses
• API
  • Summary
  • Definitions
    • Functions
      • check_args()
      • check_empty_dnp()
      • digikey_new_query_part_info()
      • download_datasheets()
      • fill_primary_list_gaps_with_secondary()
      • get_columns()
      • get_equ()
      • get_footprint_name()
      • get_html_td_string()
      • get_return_empty()
      • get_total_price_sum()
      • has_internet()
      • init_kicost()
      • main()
      • match_netlist_refs_with_api_refs()
      • mouser_new_query_part_info()
      • open_output_file()
      • output_general_info_csv()
      • output_general_info_html()
      • print_title_screen()
      • refs_sort()
      • remove_ignore_mpn_parts()
      • set_format_from_output_file_extension()
      • set_html_table()
      • write_parts_to_csv()
      • write_to_file()
      • writerow()
    • Classes
      • BaseNet
        • BaseNet.get_components()
        • BaseNet.get_refdes_from_net()
      • BaseParts
        • BaseParts.get_currency_symbol_list()
        • BaseParts.get_manufacturer_from_kicost()
        • BaseParts.get_order_code_from_kicost()
        • BaseParts.get_price_from_kicost()
        • BaseParts.get_price_tiers_from_kicost()
        • BaseParts.get_quantity_from_kicost()
        • BaseParts.get_refs_from_kicost()
        • BaseParts.get_stock_from_kicost()
        • BaseParts.get_supplier_list()
        • BaseParts.keep_only_components_in_netlist()
        • BaseParts.match_api_parts_list_with_reader_list()
        • BaseParts.search_parts_kicost()
        • BaseParts.set_blank_val_to_ignore_mpns()
      • BasePartsFileData
      • Net
        • Net.get_components()
      • NetDNP
        • NetDNP.extract_dnp()
        • NetDNP.get_components()
      • Parts
      • PartsDNP
      • PartsFileData
      • PartsFileDataDNP
• Comparisons
  • KiABOM
  • KiCost
  • KiBoM
• Development
  • Philosophy

KiABOM is licensed under the GNU General Public License v3.0 (GPLv3). This project includes and depends on the kicad_netlist_reader module, which is also licensed under the GPLv3. As a result, the KiABOM project as a whole is distributed under the terms of the GPLv3. Additionally, KiABOM incorporates components that are licensed under the MIT License. These MIT-licensed modules remain under their original license terms and are compatible with the GPLv3. For full licensing details, refer to the LICENSE file and visit https://www.gnu.org/licenses/gpl-3.0.html