kicad-sch-api 0.1.0__tar.gz → 0.1.1__tar.gz

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: kicad-sch-api
-Version: 0.1.0
+Version: 0.1.1
 Summary: Professional KiCAD schematic manipulation library with exact format preservation and AI agent integration
-Author-email: Circuit-Synth <info@circuit-synth.com>
-Maintainer-email: Circuit-Synth <info@circuit-synth.com>
+Author-email: Circuit-Synth <shane@circuit-synth.com>
+Maintainer-email: Circuit-Synth <shane@circuit-synth.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/circuit-synth/kicad-sch-api
 Project-URL: Documentation, https://circuit-synth.github.io/kicad-sch-api/

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api/core/formatter.py

@@ -51,13 +51,15 @@ class ExactFormatter:
         self.rules["kicad_sch"] = FormatRule(inline=False, indent_level=0)
         self.rules["version"] = FormatRule(inline=True)
         self.rules["generator"] = FormatRule(inline=True, quote_indices={1})
+        self.rules["generator_version"] = FormatRule(inline=True, quote_indices={1})
         self.rules["uuid"] = FormatRule(inline=True, quote_indices={1})
+        self.rules["paper"] = FormatRule(inline=True, quote_indices={1})
 
         # Title block
         self.rules["title_block"] = FormatRule(inline=False)
         self.rules["title"] = FormatRule(inline=True, quote_indices={1})
         self.rules["company"] = FormatRule(inline=True, quote_indices={1})
-        self.rules["revision"] = FormatRule(inline=True, quote_indices={1})
+        self.rules["rev"] = FormatRule(inline=True, quote_indices={1})  # KiCAD uses "rev"
         self.rules["date"] = FormatRule(inline=True, quote_indices={1})
         self.rules["size"] = FormatRule(inline=True, quote_indices={1})
         self.rules["comment"] = FormatRule(inline=True, quote_indices={2})

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api/core/parser.py

@@ -259,9 +259,10 @@ class SExpressionParser:
         if schematic_data.get("paper"):
             sexp_data.append([sexpdata.Symbol("paper"), schematic_data["paper"]])
 
-        # Add title block
-        if schematic_data.get("title_block"):
-            sexp_data.append(self._title_block_to_sexp(schematic_data["title_block"]))
+        # Add title block only if it has non-default content
+        title_block = schematic_data.get("title_block")
+        if title_block and any(title_block.get(key) for key in ["title", "company", "revision", "date", "comments"]):
+            sexp_data.append(self._title_block_to_sexp(title_block))
 
         # Add lib_symbols (always include for KiCAD compatibility)
         lib_symbols = schematic_data.get("lib_symbols", {})
@@ -421,8 +422,18 @@ class SExpressionParser:
     def _title_block_to_sexp(self, title_block: Dict[str, Any]) -> List[Any]:
         """Convert title block to S-expression."""
         sexp = [sexpdata.Symbol("title_block")]
-        for key, value in title_block.items():
-            sexp.append([sexpdata.Symbol(key), value])
+        
+        # Add standard fields
+        for key in ["title", "date", "rev", "company"]:
+            if key in title_block and title_block[key]:
+                sexp.append([sexpdata.Symbol(key), title_block[key]])
+        
+        # Add comments with special formatting
+        comments = title_block.get("comments", {})
+        if isinstance(comments, dict):
+            for comment_num, comment_text in comments.items():
+                sexp.append([sexpdata.Symbol("comment"), comment_num, comment_text])
+        
         return sexp
 
     def _symbol_to_sexp(self, symbol_data: Dict[str, Any], schematic_uuid: str = None) -> List[Any]:

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api/core/schematic.py

@@ -177,7 +177,9 @@ class Schematic:
         schematic_data["paper"] = paper
         if uuid:
             schematic_data["uuid"] = uuid
-        schematic_data["title_block"] = {"title": name}
+        # Only add title_block for non-default names to match reference format
+        if name and name not in ["Untitled", "Blank Schematic", "Single Resistor", "Two Resistors"]:
+            schematic_data["title_block"] = {"title": name}
 
         logger.info(f"Created new schematic: {name}")
         return cls(schematic_data)
@@ -813,6 +815,38 @@ class Schematic:
         logger.debug(f"Added text box: '{text}' at {position} size {size}")
         return text_box.uuid
 
+    def set_title_block(
+        self,
+        title: str = "",
+        date: str = "",
+        rev: str = "",
+        company: str = "",
+        comments: Optional[Dict[int, str]] = None
+    ):
+        """
+        Set title block information.
+
+        Args:
+            title: Schematic title
+            date: Creation/revision date
+            rev: Revision number
+            company: Company name
+            comments: Numbered comments (1, 2, 3, etc.)
+        """
+        if comments is None:
+            comments = {}
+
+        self._data["title_block"] = {
+            "title": title,
+            "date": date,
+            "rev": rev,
+            "company": company,
+            "comments": comments
+        }
+        self._modified = True
+        
+        logger.debug(f"Set title block: {title} rev {rev}")
+
     # Library management
     @property
     def libraries(self) -> "LibraryManager":
@@ -1121,13 +1155,6 @@ class Schematic:
             "generator_version": "9.0",
             "uuid": str(uuid.uuid4()),
             "paper": "A4",
-            "title_block": {
-                "title": "Untitled",
-                "date": "",
-                "revision": "1.0",
-                "company": "",
-                "size": "A4",
-            },
             "components": [],
             "wires": [],
             "junctions": [],

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api/core/types.py

@@ -409,7 +409,7 @@ class TitleBlock:
 
     title: str = ""
     company: str = ""
-    revision: str = ""
+    rev: str = ""  # KiCAD uses "rev" not "revision"
     date: str = ""
     size: str = "A4"
     comments: Dict[int, str] = field(default_factory=dict)

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: kicad-sch-api
-Version: 0.1.0
+Version: 0.1.1
 Summary: Professional KiCAD schematic manipulation library with exact format preservation and AI agent integration
-Author-email: Circuit-Synth <info@circuit-synth.com>
-Maintainer-email: Circuit-Synth <info@circuit-synth.com>
+Author-email: Circuit-Synth <shane@circuit-synth.com>
+Maintainer-email: Circuit-Synth <shane@circuit-synth.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/circuit-synth/kicad-sch-api
 Project-URL: Documentation, https://circuit-synth.github.io/kicad-sch-api/

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/kicad_sch_api.egg-info/SOURCES.txt

@@ -42,6 +42,8 @@ tests/reference_tests/reference_kicad_projects/power_symbols/power_symbols.kicad
 tests/reference_tests/reference_kicad_projects/power_symbols/power_symbols.kicad_sch
 tests/reference_tests/reference_kicad_projects/resistor_divider/resistor_divider.kicad_pro
 tests/reference_tests/reference_kicad_projects/resistor_divider/resistor_divider.kicad_sch
+tests/reference_tests/reference_kicad_projects/sch_title/sch_title.kicad_pro
+tests/reference_tests/reference_kicad_projects/sch_title/sch_title.kicad_sch
 tests/reference_tests/reference_kicad_projects/single_extended_component/single_extended_component.kicad_pro
 tests/reference_tests/reference_kicad_projects/single_extended_component/single_extended_component.kicad_sch
 tests/reference_tests/reference_kicad_projects/single_hierarchical_sheet/single_hierarchical_sheet.kicad_pro

{kicad_sch_api-0.1.0 → kicad_sch_api-0.1.1}/pyproject.toml

@@ -4,15 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "kicad-sch-api"
-version = "0.1.0"
+version = "0.1.1"
 description = "Professional KiCAD schematic manipulation library with exact format preservation and AI agent integration"
 readme = "README.md"
 license = "MIT"
 authors = [
-    {name = "Circuit-Synth", email = "info@circuit-synth.com"}
+    {name = "Circuit-Synth", email = "shane@circuit-synth.com"}
 ]
 maintainers = [
-    {name = "Circuit-Synth", email = "info@circuit-synth.com"}
+    {name = "Circuit-Synth", email = "shane@circuit-synth.com"}
 ]
 keywords = [
     "kicad", "schematic", "eda", "electronics", "circuit-design", 

kicad_sch_api-0.1.1/tests/reference_tests/reference_kicad_projects/sch_title/sch_title.kicad_pro

@@ -0,0 +1,417 @@
+{
+  "board": {
+    "3dviewports": [],
+    "design_settings": {
+      "defaults": {},
+      "diff_pair_dimensions": [],
+      "drc_exclusions": [],
+      "rules": {},
+      "track_widths": [],
+      "via_dimensions": []
+    },
+    "ipc2581": {
+      "dist": "",
+      "distpn": "",
+      "internal_id": "",
+      "mfg": "",
+      "mpn": ""
+    },
+    "layer_pairs": [],
+    "layer_presets": [],
+    "viewports": []
+  },
+  "boards": [],
+  "cvpcb": {
+    "equivalence_files": []
+  },
+  "erc": {
+    "erc_exclusions": [],
+    "meta": {
+      "version": 0
+    },
+    "pin_map": [
+      [
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        1,
+        0,
+        0,
+        0,
+        0,
+        2
+      ],
+      [
+        0,
+        2,
+        0,
+        1,
+        0,
+        0,
+        1,
+        0,
+        2,
+        2,
+        2,
+        2
+      ],
+      [
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        1,
+        0,
+        1,
+        0,
+        1,
+        2
+      ],
+      [
+        0,
+        1,
+        0,
+        0,
+        0,
+        0,
+        1,
+        1,
+        2,
+        1,
+        1,
+        2
+      ],
+      [
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        1,
+        0,
+        0,
+        0,
+        0,
+        2
+      ],
+      [
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        2
+      ],
+      [
+        1,
+        1,
+        1,
+        1,
+        1,
+        0,
+        1,
+        1,
+        1,
+        1,
+        1,
+        2
+      ],
+      [
+        0,
+        0,
+        0,
+        1,
+        0,
+        0,
+        1,
+        0,
+        0,
+        0,
+        0,
+        2
+      ],
+      [
+        0,
+        2,
+        1,
+        2,
+        0,
+        0,
+        1,
+        0,
+        2,
+        2,
+        2,
+        2
+      ],
+      [
+        0,
+        2,
+        0,
+        1,
+        0,
+        0,
+        1,
+        0,
+        2,
+        0,
+        0,
+        2
+      ],
+      [
+        0,
+        2,
+        1,
+        1,
+        0,
+        0,
+        1,
+        0,
+        2,
+        0,
+        0,
+        2
+      ],
+      [
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2,
+        2
+      ]
+    ],
+    "rule_severities": {
+      "bus_definition_conflict": "error",
+      "bus_entry_needed": "error",
+      "bus_to_bus_conflict": "error",
+      "bus_to_net_conflict": "error",
+      "different_unit_footprint": "error",
+      "different_unit_net": "error",
+      "duplicate_reference": "error",
+      "duplicate_sheet_names": "error",
+      "endpoint_off_grid": "warning",
+      "extra_units": "error",
+      "footprint_filter": "ignore",
+      "footprint_link_issues": "warning",
+      "four_way_junction": "ignore",
+      "global_label_dangling": "warning",
+      "hier_label_mismatch": "error",
+      "label_dangling": "error",
+      "label_multiple_wires": "warning",
+      "lib_symbol_issues": "warning",
+      "lib_symbol_mismatch": "warning",
+      "missing_bidi_pin": "warning",
+      "missing_input_pin": "warning",
+      "missing_power_pin": "error",
+      "missing_unit": "warning",
+      "multiple_net_names": "warning",
+      "net_not_bus_member": "warning",
+      "no_connect_connected": "warning",
+      "no_connect_dangling": "warning",
+      "pin_not_connected": "error",
+      "pin_not_driven": "error",
+      "pin_to_pin": "warning",
+      "power_pin_not_driven": "error",
+      "same_local_global_label": "warning",
+      "similar_label_and_power": "warning",
+      "similar_labels": "warning",
+      "similar_power": "warning",
+      "simulation_model_issue": "ignore",
+      "single_global_label": "ignore",
+      "unannotated": "error",
+      "unconnected_wire_endpoint": "warning",
+      "unit_value_mismatch": "error",
+      "unresolved_variable": "error",
+      "wire_dangling": "error"
+    }
+  },
+  "libraries": {
+    "pinned_footprint_libs": [],
+    "pinned_symbol_libs": []
+  },
+  "meta": {
+    "filename": "sch_title.kicad_pro",
+    "version": 3
+  },
+  "net_settings": {
+    "classes": [
+      {
+        "bus_width": 12,
+        "clearance": 0.2,
+        "diff_pair_gap": 0.25,
+        "diff_pair_via_gap": 0.25,
+        "diff_pair_width": 0.2,
+        "line_style": 0,
+        "microvia_diameter": 0.3,
+        "microvia_drill": 0.1,
+        "name": "Default",
+        "pcb_color": "rgba(0, 0, 0, 0.000)",
+        "priority": 2147483647,
+        "schematic_color": "rgba(0, 0, 0, 0.000)",
+        "track_width": 0.2,
+        "via_diameter": 0.6,
+        "via_drill": 0.3,
+        "wire_width": 6
+      }
+    ],
+    "meta": {
+      "version": 4
+    },
+    "net_colors": null,
+    "netclass_assignments": null,
+    "netclass_patterns": []
+  },
+  "pcbnew": {
+    "last_paths": {
+      "gencad": "",
+      "idf": "",
+      "netlist": "",
+      "plot": "",
+      "pos_files": "",
+      "specctra_dsn": "",
+      "step": "",
+      "svg": "",
+      "vrml": ""
+    },
+    "page_layout_descr_file": ""
+  },
+  "schematic": {
+    "annotate_start_num": 0,
+    "bom_export_filename": "${PROJECTNAME}.csv",
+    "bom_fmt_presets": [],
+    "bom_fmt_settings": {
+      "field_delimiter": ",",
+      "keep_line_breaks": false,
+      "keep_tabs": false,
+      "name": "CSV",
+      "ref_delimiter": ",",
+      "ref_range_delimiter": "",
+      "string_delimiter": "\""
+    },
+    "bom_presets": [],
+    "bom_settings": {
+      "exclude_dnp": false,
+      "fields_ordered": [
+        {
+          "group_by": false,
+          "label": "Reference",
+          "name": "Reference",
+          "show": true
+        },
+        {
+          "group_by": false,
+          "label": "Qty",
+          "name": "${QUANTITY}",
+          "show": true
+        },
+        {
+          "group_by": true,
+          "label": "Value",
+          "name": "Value",
+          "show": true
+        },
+        {
+          "group_by": true,
+          "label": "DNP",
+          "name": "${DNP}",
+          "show": true
+        },
+        {
+          "group_by": true,
+          "label": "Exclude from BOM",
+          "name": "${EXCLUDE_FROM_BOM}",
+          "show": true
+        },
+        {
+          "group_by": true,
+          "label": "Exclude from Board",
+          "name": "${EXCLUDE_FROM_BOARD}",
+          "show": true
+        },
+        {
+          "group_by": true,
+          "label": "Footprint",
+          "name": "Footprint",
+          "show": true
+        },
+        {
+          "group_by": false,
+          "label": "Datasheet",
+          "name": "Datasheet",
+          "show": true
+        }
+      ],
+      "filter_string": "",
+      "group_symbols": true,
+      "include_excluded_from_bom": true,
+      "name": "Default Editing",
+      "sort_asc": true,
+      "sort_field": "Reference"
+    },
+    "connection_grid_size": 50.0,
+    "drawing": {
+      "dashed_lines_dash_length_ratio": 12.0,
+      "dashed_lines_gap_length_ratio": 3.0,
+      "default_line_thickness": 6.0,
+      "default_text_size": 50.0,
+      "field_names": [],
+      "intersheets_ref_own_page": false,
+      "intersheets_ref_prefix": "",
+      "intersheets_ref_short": false,
+      "intersheets_ref_show": false,
+      "intersheets_ref_suffix": "",
+      "junction_size_choice": 3,
+      "label_size_ratio": 0.375,
+      "operating_point_overlay_i_precision": 3,
+      "operating_point_overlay_i_range": "~A",
+      "operating_point_overlay_v_precision": 3,
+      "operating_point_overlay_v_range": "~V",
+      "overbar_offset_ratio": 1.23,
+      "pin_symbol_size": 25.0,
+      "text_offset_ratio": 0.15
+    },
+    "legacy_lib_dir": "",
+    "legacy_lib_list": [],
+    "meta": {
+      "version": 1
+    },
+    "net_format_name": "",
+    "page_layout_descr_file": "",
+    "plot_directory": "",
+    "space_save_all_events": true,
+    "spice_current_sheet_as_root": false,
+    "spice_external_command": "spice \"%I\"",
+    "spice_model_current_sheet_as_root": true,
+    "spice_save_all_currents": false,
+    "spice_save_all_dissipations": false,
+    "spice_save_all_voltages": false,
+    "subpart_first_id": 65,
+    "subpart_id_separator": 0
+  },
+  "sheets": [
+    [
+      "bad59254-4c4b-4281-8e5a-889c52dc7b3a",
+      "Root"
+    ]
+  ],
+  "text_variables": {}
+}

kicad_sch_api-0.1.1/tests/reference_tests/reference_kicad_projects/sch_title/sch_title.kicad_sch

@@ -0,0 +1,23 @@
+(kicad_sch
+	(version 20250114)
+	(generator "eeschema")
+	(generator_version "9.0")
+	(uuid "bad59254-4c4b-4281-8e5a-889c52dc7b3a")
+	(paper "A4")
+	(title_block
+		(title "kicad-sch-api demo")
+		(date "2025-08-17")
+		(rev "v0.0.1")
+		(company "Circuit-Synth")
+		(comment 1 "first comment")
+		(comment 2 "second comment")
+		(comment 3 "third comment")
+	)
+	(lib_symbols)
+	(sheet_instances
+		(path "/"
+			(page "1")
+		)
+	)
+	(embedded_fonts no)
+)