kicad-tools 0.1.0__tar.gz

kicad_tools-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: |
+          ruff check src/
+
+      - name: Test with pytest
+        run: |
+          pytest tests/ -v --cov=kicad_tools --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false

kicad_tools-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

kicad_tools-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+*.cover
+
+# Build
+*.whl
+*.tar.gz
+
+# OS
+.DS_Store
+Thumbs.db

kicad_tools-0.1.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-12-29
+
+### Added
+
+- **Core S-expression parser** with round-trip editing support
+- **Schematic parsing** - symbols, wires, labels, hierarchy traversal
+- **PCB parsing** - footprints, nets, traces, vias, zones
+- **Symbol library parsing** - read and query KiCad symbol libraries
+- **ERC report parsing** - parse KiCad Electrical Rules Check reports
+- **DRC report parsing** - parse KiCad Design Rules Check reports
+- **Manufacturer profiles** - design rules for JLCPCB, OSHPark, PCBWay, Seeed
+- **PCB autorouter** - A* pathfinding with pluggable heuristics
+  - Net class awareness (power, clock, audio, digital)
+  - Multi-layer support with via management
+  - Congestion-aware routing
+- **Unified CLI** (`kct` or `kicad-tools`) with subcommands:
+  - `kct symbols` - list symbols in schematics
+  - `kct nets` - trace and analyze nets
+  - `kct bom` - generate bill of materials
+  - `kct erc` - run/parse ERC reports
+  - `kct drc` - run/parse DRC reports with manufacturer rules
+- **PCB tools** - `kicad-pcb-query` and `kicad-pcb-modify`
+- **Library tools** - `kicad-lib-symbols`
+- JSON output for all CLI commands
+
+### Dependencies
+
+- Python 3.10+
+- numpy >= 1.20
+
+[0.1.0]: https://github.com/rjwalters/kicad-tools/releases/tag/v0.1.0

kicad_tools-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RJ Walters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kicad_tools-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: kicad-tools
+Version: 0.1.0
+Summary: Standalone Python tools for parsing and manipulating KiCad schematic and PCB files
+Project-URL: Homepage, https://github.com/rjwalters/kicad-tools
+Project-URL: Repository, https://github.com/rjwalters/kicad-tools
+Project-URL: Issues, https://github.com/rjwalters/kicad-tools/issues
+Author: RJ Walters
+License-Expression: MIT
+License-File: LICENSE
+Keywords: automation,drc,eda,electronics,erc,hardware,kicad,pcb,schematic
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.20
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# kicad-tools
+
+[![PyPI version](https://badge.fury.io/py/kicad-tools.svg)](https://pypi.org/project/kicad-tools/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Standalone Python tools for parsing and manipulating KiCad schematic and PCB files.
+
+**No running KiCad instance required** - works directly with `.kicad_sch` and `.kicad_pcb` files.
+
+## Installation
+
+```bash
+pip install kicad-tools
+```
+
+## Quick Start
+
+### Command Line (`kct`)
+
+```bash
+# List symbols in a schematic
+kct symbols project.kicad_sch
+kct symbols project.kicad_sch --format json
+
+# Trace nets
+kct nets project.kicad_sch
+kct nets project.kicad_sch --net VCC
+
+# Generate bill of materials
+kct bom project.kicad_sch
+kct bom project.kicad_sch --format csv --group
+
+# Run ERC (requires kicad-cli)
+kct erc project.kicad_sch
+kct erc project.kicad_sch --strict
+
+# Run DRC with manufacturer rules
+kct drc board.kicad_pcb
+kct drc board.kicad_pcb --mfr jlcpcb
+kct drc --compare  # Compare manufacturer rules
+```
+
+### Python API
+
+```python
+from kicad_tools import load_schematic, Schematic
+
+# Load and parse a schematic
+doc = load_schematic("project.kicad_sch")
+sch = Schematic(doc)
+
+# Access symbols
+for symbol in sch.symbols:
+    print(f"{symbol.reference}: {symbol.value}")
+
+# Access hierarchy
+for sheet in sch.sheets:
+    print(f"Sheet: {sheet.name}")
+```
+
+### PCB Autorouter
+
+```python
+from kicad_tools.router import Autorouter, DesignRules
+
+# Configure design rules
+rules = DesignRules(
+    grid_resolution=0.25,  # mm
+    trace_width=0.2,       # mm
+    clearance=0.15,        # mm
+)
+
+# Create router and add components
+router = Autorouter(width=100, height=80, rules=rules)
+router.add_component("U1", pads=[...])
+
+# Route all nets
+result = router.route_all()
+print(f"Routed {result.routed_nets}/{result.total_nets} nets")
+```
+
+## CLI Commands
+
+### Unified CLI (`kct` or `kicad-tools`)
+
+| Command | Description |
+|---------|-------------|
+| `kct symbols <schematic>` | List symbols with filtering |
+| `kct nets <schematic>` | Trace and analyze nets |
+| `kct bom <schematic>` | Generate bill of materials |
+| `kct erc <schematic>` | Run electrical rules check |
+| `kct drc <pcb>` | Run design rules check |
+
+All commands support `--format json` for machine-readable output.
+
+### PCB Tools
+
+| Command | Description |
+|---------|-------------|
+| `kicad-pcb-query summary` | Board overview |
+| `kicad-pcb-query footprints` | List footprints |
+| `kicad-pcb-query nets` | List all nets |
+| `kicad-pcb-query traces` | Trace statistics |
+| `kicad-pcb-modify move` | Move component |
+| `kicad-pcb-modify rotate` | Rotate component |
+
+### Library Tools
+
+| Command | Description |
+|---------|-------------|
+| `kicad-lib-symbols` | List symbols in library |
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `core` | S-expression parsing and file I/O |
+| `schema` | Data models (Schematic, PCB, Symbol, Wire, Label) |
+| `drc` | Design Rule Check report parsing |
+| `erc` | Electrical Rule Check report parsing |
+| `manufacturers` | PCB fab profiles (JLCPCB, OSHPark, PCBWay, Seeed) |
+| `operations` | Schematic operations (net tracing, symbol replacement) |
+| `router` | A* PCB autorouter with pluggable heuristics |
+
+## Features
+
+- **Pure Python parsing** - No KiCad installation needed
+- **Round-trip editing** - Parse, modify, and save files preserving formatting
+- **Full S-expression support** - Handles all KiCad 8.0+ file formats
+- **Schematic analysis** - Symbols, wires, labels, hierarchy traversal
+- **PCB analysis** - Footprints, nets, traces, vias, zones
+- **Manufacturer rules** - JLCPCB, PCBWay, OSHPark, Seeed design rules
+- **PCB autorouter** - A* pathfinding with net class awareness
+- **JSON output** - Machine-readable output for automation
+
+## Requirements
+
+- Python 3.10+
+- numpy (for router module)
+- KiCad 8+ (optional) - for running ERC/DRC via `kicad-cli`
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/rjwalters/kicad-tools.git
+cd kicad-tools
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Run linter
+ruff check src/
+
+# Format code
+ruff format src/
+```
+
+## License
+
+MIT

kicad_tools-0.1.0/README.md

@@ -0,0 +1,165 @@
+# kicad-tools
+
+[![PyPI version](https://badge.fury.io/py/kicad-tools.svg)](https://pypi.org/project/kicad-tools/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Standalone Python tools for parsing and manipulating KiCad schematic and PCB files.
+
+**No running KiCad instance required** - works directly with `.kicad_sch` and `.kicad_pcb` files.
+
+## Installation
+
+```bash
+pip install kicad-tools
+```
+
+## Quick Start
+
+### Command Line (`kct`)
+
+```bash
+# List symbols in a schematic
+kct symbols project.kicad_sch
+kct symbols project.kicad_sch --format json
+
+# Trace nets
+kct nets project.kicad_sch
+kct nets project.kicad_sch --net VCC
+
+# Generate bill of materials
+kct bom project.kicad_sch
+kct bom project.kicad_sch --format csv --group
+
+# Run ERC (requires kicad-cli)
+kct erc project.kicad_sch
+kct erc project.kicad_sch --strict
+
+# Run DRC with manufacturer rules
+kct drc board.kicad_pcb
+kct drc board.kicad_pcb --mfr jlcpcb
+kct drc --compare  # Compare manufacturer rules
+```
+
+### Python API
+
+```python
+from kicad_tools import load_schematic, Schematic
+
+# Load and parse a schematic
+doc = load_schematic("project.kicad_sch")
+sch = Schematic(doc)
+
+# Access symbols
+for symbol in sch.symbols:
+    print(f"{symbol.reference}: {symbol.value}")
+
+# Access hierarchy
+for sheet in sch.sheets:
+    print(f"Sheet: {sheet.name}")
+```
+
+### PCB Autorouter
+
+```python
+from kicad_tools.router import Autorouter, DesignRules
+
+# Configure design rules
+rules = DesignRules(
+    grid_resolution=0.25,  # mm
+    trace_width=0.2,       # mm
+    clearance=0.15,        # mm
+)
+
+# Create router and add components
+router = Autorouter(width=100, height=80, rules=rules)
+router.add_component("U1", pads=[...])
+
+# Route all nets
+result = router.route_all()
+print(f"Routed {result.routed_nets}/{result.total_nets} nets")
+```
+
+## CLI Commands
+
+### Unified CLI (`kct` or `kicad-tools`)
+
+| Command | Description |
+|---------|-------------|
+| `kct symbols <schematic>` | List symbols with filtering |
+| `kct nets <schematic>` | Trace and analyze nets |
+| `kct bom <schematic>` | Generate bill of materials |
+| `kct erc <schematic>` | Run electrical rules check |
+| `kct drc <pcb>` | Run design rules check |
+
+All commands support `--format json` for machine-readable output.
+
+### PCB Tools
+
+| Command | Description |
+|---------|-------------|
+| `kicad-pcb-query summary` | Board overview |
+| `kicad-pcb-query footprints` | List footprints |
+| `kicad-pcb-query nets` | List all nets |
+| `kicad-pcb-query traces` | Trace statistics |
+| `kicad-pcb-modify move` | Move component |
+| `kicad-pcb-modify rotate` | Rotate component |
+
+### Library Tools
+
+| Command | Description |
+|---------|-------------|
+| `kicad-lib-symbols` | List symbols in library |
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `core` | S-expression parsing and file I/O |
+| `schema` | Data models (Schematic, PCB, Symbol, Wire, Label) |
+| `drc` | Design Rule Check report parsing |
+| `erc` | Electrical Rule Check report parsing |
+| `manufacturers` | PCB fab profiles (JLCPCB, OSHPark, PCBWay, Seeed) |
+| `operations` | Schematic operations (net tracing, symbol replacement) |
+| `router` | A* PCB autorouter with pluggable heuristics |
+
+## Features
+
+- **Pure Python parsing** - No KiCad installation needed
+- **Round-trip editing** - Parse, modify, and save files preserving formatting
+- **Full S-expression support** - Handles all KiCad 8.0+ file formats
+- **Schematic analysis** - Symbols, wires, labels, hierarchy traversal
+- **PCB analysis** - Footprints, nets, traces, vias, zones
+- **Manufacturer rules** - JLCPCB, PCBWay, OSHPark, Seeed design rules
+- **PCB autorouter** - A* pathfinding with net class awareness
+- **JSON output** - Machine-readable output for automation
+
+## Requirements
+
+- Python 3.10+
+- numpy (for router module)
+- KiCad 8+ (optional) - for running ERC/DRC via `kicad-cli`
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/rjwalters/kicad-tools.git
+cd kicad-tools
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Run linter
+ruff check src/
+
+# Format code
+ruff format src/
+```
+
+## License
+
+MIT