Refactor all kicad specific code into separate module

... that doesn't get imported unless it is needed.
This is preparation for adding easyeda support.

Issue #95

Author: qu1ck

InteractiveHtmlBom/__init__.py

@@ -1,13 +1,11 @@
+import os
 import sys
 import threading
 import time
 
-import pcbnew
 import wx
 import wx.aui
 
-from .generate_interactive_bom import InteractiveHtmlBomPlugin
-
 
 def check_for_bom_button():
     # From Miles McCoo's blog
@@ -22,19 +20,20 @@ def find_pcbnew_window():
     def callback(_):
         plugin.Run()
 
-    import os
     path = os.path.dirname(__file__)
     while not wx.GetApp():
         time.sleep(1)
     bm = wx.Bitmap(path + '/icon.png', wx.BITMAP_TYPE_PNG)
     button_wx_item_id = 0
+
+    from pcbnew import ID_H_TOOLBAR
     while True:
         time.sleep(1)
-        pcbwin = find_pcbnew_window()
-        if not pcbwin:
+        pcbnew_window = find_pcbnew_window()
+        if not pcbnew_window:
             continue
 
-        top_tb = pcbwin.FindWindowById(pcbnew.ID_H_TOOLBAR)
+        top_tb = pcbnew_window.FindWindowById(ID_H_TOOLBAR)
         if button_wx_item_id == 0 or not top_tb.FindTool(button_wx_item_id):
             top_tb.AddSeparator()
             button_wx_item_id = wx.NewId()
@@ -44,13 +43,16 @@ def callback(_):
             top_tb.Realize()
 
 
-plugin = InteractiveHtmlBomPlugin()
-plugin.defaults()
-plugin.register()
+if not os.environ.get('INTERACTIVE_HTML_BOM_CLI_MODE', False):
+    from .ecad.kicad import InteractiveHtmlBomPlugin
+
+    plugin = InteractiveHtmlBomPlugin()
+    plugin.defaults()
+    plugin.register()
 
-# Add a button the hacky way if plugin button is not supported
-# in pcbnew, unless this is linux.
-if not plugin.pcbnew_icon_support and not sys.platform.startswith('linux'):
-    t = threading.Thread(target=check_for_bom_button)
-    t.daemon = True
-    t.start()
+    # Add a button the hacky way if plugin button is not supported
+    # in pcbnew, unless this is linux.
+    if not plugin.pcbnew_icon_support and not sys.platform.startswith('linux'):
+        t = threading.Thread(target=check_for_bom_button)
+        t.daemon = True
+        t.start()

InteractiveHtmlBom/core/config.py

@@ -9,6 +9,21 @@
 
 
 class Config:
+    FILE_NAME_FORMAT_HINT = (
+            'Output file name format supports substitutions:\n'
+            '\n'
+            '    %f : original pcb file name without extension.\n'
+            '    %p : pcb/project title from pcb metadata.\n'
+            '    %c : company from pcb metadata.\n'
+            '    %r : revision from pcb metadata.\n'
+            '    %d : pcb date from metadata if available, '
+            'file modification date otherwise.\n'
+            '    %D : bom generation date.\n'
+            '    %T : bom generation time.\n'
+            '\n'
+            'Extension .html will be added automatically.'
+    )  # type: str
+
     # Helper constants
     config_file = os.path.join(os.path.dirname(__file__), '..', 'config.ini')
     bom_view_choices = ['bom-only', 'left-right', 'top-bottom']