Merge pull request #48 from uPesy/dev

Add project relative path for 3D model in footprint lib file + handle EasyEDA API 404 response

Author: uPesy

.gitignore

@@ -4,6 +4,7 @@ scripts/*
 .vscode/*
 *.sqlite3
 TODO
+easyeda2kicad_config.json
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -1,4 +1,4 @@
-# easyeda2kicad v0.3.7
+# easyeda2kicad v0.4.0
 
 _________________
 [![PyPI version](https://badge.fury.io/py/easyeda2kicad.svg)](https://badge.fury.io/py/easyeda2kicad)

easyeda2kicad/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "0.3.7"
+__version__ = "0.4.0"
 __author__ = "uPesy"
 __email__ = "[email protected]"

easyeda2kicad/__main__.py

@@ -17,6 +17,7 @@
 from easyeda2kicad.easyeda.parameters_easyeda import EeSymbol
 from easyeda2kicad.helpers import (
     add_component_in_symbol_lib_file,
+    get_local_config,
     id_already_in_symbol_lib,
     set_logger,
     update_component_in_symbol_lib_file,
@@ -66,7 +67,7 @@ def get_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "--output",
         required=False,
-        metavar="file.lib",
+        metavar="file.kicad_sym",
         help="Output file",
         type=str,
     )
@@ -88,6 +89,13 @@ def get_parser() -> argparse.ArgumentParser:
         action="store_true",
     )
 
+    parser.add_argument(
+        "--project-relative",
+        required=False,
+        help="Sets the 3D file path stored relative to the project",
+        action="store_true",
+    )
+
     return parser
 
 
@@ -111,6 +119,16 @@ def valid_arguments(arguments: dict) -> bool:
     kicad_version = KicadVersion.v5 if arguments.get("v5") else KicadVersion.v6
     arguments["kicad_version"] = kicad_version
 
+    if arguments["project_relative"] and not arguments["output"]:
+        logging.error(
+            "A project specific library path should be given with --output option when"
+            " using --project-relative option\nFor example: easyeda2kicad"
+            " --lcsc_id=C2040 --full"
+            " --output=C:/Users/your_username/Documents/Kicad/6.0/projects/my_project"
+            " --project-relative"
+        )
+        return False
+
     if arguments["output"]:
         base_folder = "/".join(arguments["output"].replace("\\", "/").split("/")[:-1])
         lib_name = (
@@ -122,7 +140,7 @@ def valid_arguments(arguments: dict) -> bool:
         )
 
         if not os.path.isdir(base_folder):
-            logging.error("Can't find the folder")
+            logging.error(f"Can't find the folder : {base_folder}")
             return False
     else:
         default_folder = os.path.join(
@@ -208,6 +226,8 @@ def main(argv: List[str] = sys.argv[1:]) -> int:
     if not valid_arguments(arguments=arguments):
         return 1
 
+    # conf = get_local_config()
+
     component_id = arguments["lcsc_id"]
     kicad_version = arguments["kicad_version"]
     sym_lib_ext = "kicad_sym" if kicad_version == KicadVersion.v6 else "lib"
@@ -216,6 +236,11 @@ def main(argv: List[str] = sys.argv[1:]) -> int:
     api = EasyedaApi()
     cad_data = api.get_cad_data_of_component(lcsc_id=component_id)
 
+    # API returned no data
+    if not cad_data:
+        logging.error(f"Failed to fetch data from EasyEDA API for part {component_id}")
+        return 1
+
     # ---------------- SYMBOL ----------------
     if arguments["symbol"]:
         importer = EasyedaSymbolImporter(easyeda_cp_cad_data=cad_data)
@@ -269,7 +294,8 @@ def main(argv: List[str] = sys.argv[1:]) -> int:
 
         logging.info(f"Creating Kicad footprint library for LCSC id : {component_id}")
         ExporterFootprintKicad(footprint=easyeda_footprint).export(
-            output_path=arguments["output"]
+            output_path=arguments["output"],
+            is_project_relative=arguments["project_relative"],
         )
 
     # ---------------- 3D MODEL ----------------

easyeda2kicad/helpers.py

@@ -1,7 +1,11 @@
 # Global imports
+import json
 import logging
+import os
 import re
+from datetime import datetime
 
+from easyeda2kicad import __version__
 from easyeda2kicad.kicad.parameters_kicad_symbol import KicadVersion, sanitize_fields
 
 sym_lib_regex_pattern = {
@@ -104,3 +108,20 @@ def add_component_in_symbol_lib_file(
                     "(generator https://github.com/uPesy/easyeda2kicad.py)",
                 )
             )
+
+
+def get_local_config() -> dict:
+    if not os.path.isfile("easyeda2kicad_config.json"):
+        with open(file="easyeda2kicad_config.json", mode="w", encoding="utf-8") as conf:
+            json.dump(
+                {"updated_at": datetime.utcnow().timestamp(), "version": __version__},
+                conf,
+                indent=4,
+                ensure_ascii=False,
+            )
+        logging.info("Create easyeda2kicad_config.json config file")
+
+    with open(file="easyeda2kicad_config.json", encoding="utf-8") as conf:
+        local_conf: dict = json.load(conf)
+
+    return local_conf

easyeda2kicad/kicad/export_kicad_footprint.py

@@ -435,7 +435,8 @@ def generate_kicad_footprint(self) -> None:
     def get_ki_footprint(self) -> KiFootprint:
         return self.output
 
-    def export(self, output_path: str) -> None:
+    def export(self, output_path: str, is_project_relative: bool) -> None:
+
         ki = self.output
         ki_lib = ""
 
@@ -486,8 +487,11 @@ def export(self, output_path: str) -> None:
             ki_lib += KI_TEXT.format(**vars(text))
 
         if ki.model_3d is not None:
+            model_3d_path = output_path
+            if is_project_relative:
+                model_3d_path = "${KIPRJMOD}/" + model_3d_path.split("/")[-1]
             ki_lib += KI_MODEL_3D.format(
-                file_3d=f"{output_path}.3dshapes/{ki.model_3d.name}.wrl",
+                file_3d=f"{model_3d_path}.3dshapes/{ki.model_3d.name}.wrl",
                 pos_x=ki.model_3d.translation.x,
                 pos_y=ki.model_3d.translation.y,
                 pos_z=ki.model_3d.translation.z,

ressources/jlcpcb_banner.png

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.7
+current_version = 0.4.0
 commit = True
 tag = True
 

setup.cfg

@@ -11,7 +11,7 @@
     ),
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="0.3.7",
+    version="0.4.0",
     author="uPesy",
     author_email="[email protected]",
     url="https://github.com/uPesy/easyeda2kicad.py",