kicad-sch-api 0.1.7__py3-none-any.whl → 0.2.1__py3-none-any.whl

kicad_sch_api-0.1.7.dist-info/METADATA

@@ -1,322 +0,0 @@
-Metadata-Version: 2.4
-Name: kicad-sch-api
-Version: 0.1.7
-Summary: Professional KiCAD schematic manipulation library with exact format preservation and AI agent integration
-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/
-Project-URL: Repository, https://github.com/circuit-synth/kicad-sch-api.git
-Project-URL: Bug Reports, https://github.com/circuit-synth/kicad-sch-api/issues
-Project-URL: Changelog, https://github.com/circuit-synth/kicad-sch-api/blob/main/CHANGELOG.md
-Keywords: kicad,schematic,eda,electronics,circuit-design,ai,automation,pcb
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fastmcp>=2.0.0
-Requires-Dist: mcp[cli]>=1.13.0
-Requires-Dist: sexpdata>=0.0.3
-Requires-Dist: typing-extensions>=4.0.0; python_version < "3.11"
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
-Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
-Requires-Dist: black>=22.0.0; extra == "dev"
-Requires-Dist: isort>=5.0.0; extra == "dev"
-Requires-Dist: flake8>=4.0.0; extra == "dev"
-Requires-Dist: mypy>=1.0.0; extra == "dev"
-Requires-Dist: pre-commit>=3.0.0; extra == "dev"
-Provides-Extra: mcp
-Requires-Dist: mcp[cli]>=1.0.0; extra == "mcp"
-Requires-Dist: fastmcp>=2.0.0; extra == "mcp"
-Provides-Extra: docs
-Requires-Dist: sphinx>=5.0.0; extra == "docs"
-Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
-Requires-Dist: myst-parser>=0.18.0; extra == "docs"
-Dynamic: license-file
-
-# KiCAD Schematic API
-
-**Professional Python library for KiCAD schematic file manipulation with exact format preservation**
-
-## Overview
-
-Create and manipulate KiCAD schematic files programmatically with guaranteed exact format preservation. This library serves as the foundation for EDA automation tools and AI agents that need reliable, professional-grade schematic manipulation capabilities.
-
-## 🎯 Core Features
-
-- **📋 Exact Format Preservation**: Byte-perfect KiCAD output that matches native formatting
-- **🏗️ Professional Component Management**: Object-oriented collections with search and validation
-- **⚡ High Performance**: Optimized for large schematics with intelligent caching
-- **🔍 Real KiCAD Library Integration**: Access to actual KiCAD symbol libraries and validation
-- **🤖 AI Agent Ready**: MCP server for seamless integration with AI development tools
-- **📚 Hierarchical Design**: Complete support for multi-sheet schematic projects
-
-## 🚀 Quick Start
-
-### Installation
-
-```bash
-# Install from PyPI
-pip install kicad-sch-api
-
-# Or install from source
-git clone https://github.com/circuit-synth/kicad-sch-api.git
-cd kicad-sch-api/python
-uv pip install -e .
-```
-
-### Basic Usage
-
-```python
-import kicad_sch_api as ksa
-
-# Create a new schematic
-sch = ksa.create_schematic("My Circuit")
-
-# Add components with proper validation
-resistor = sch.components.add(
-    lib_id="Device:R",
-    reference="R1", 
-    value="10k",
-    position=(100.0, 100.0),
-    footprint="Resistor_SMD:R_0603_1608Metric",
-    datasheet="~",
-    description="Resistor"
-)
-
-capacitor = sch.components.add(
-    lib_id="Device:C",
-    reference="C1", 
-    value="100nF",
-    position=(150.0, 100.0),
-    footprint="Capacitor_SMD:C_0603_1608Metric"
-)
-
-# Save with exact format preservation
-sch.save("my_circuit.kicad_sch")
-```
-
-### Hierarchical Design
-
-```python
-# Create main schematic with hierarchical sheet
-main_sch = ksa.create_schematic("Main Board")
-
-# Add hierarchical sheet
-power_sheet = main_sch.add_hierarchical_sheet(
-    name="Power Supply",
-    filename="power.kicad_sch",
-    position=(100, 100),
-    size=(80, 60)
-)
-
-# Add sheet pins for connectivity
-power_sheet.add_pin("VIN", pin_type="input", position=(0, 10))
-power_sheet.add_pin("VOUT", pin_type="output", position=(80, 10))
-
-# Create the sub-schematic
-power_sch = ksa.create_schematic("Power Supply")
-power_sch.add_hierarchical_label("VIN", label_type="input", position=(50, 25))
-power_sch.add_hierarchical_label("VOUT", label_type="output", position=(150, 25))
-
-# Save both schematics
-main_sch.save("main.kicad_sch")
-power_sch.save("power.kicad_sch")
-```
-
-## 🔧 Advanced Features
-
-### Component Search and Management
-
-```python
-# Search for components
-resistors = sch.components.find(lib_id_pattern='Device:R*')
-power_components = sch.components.filter(reference_pattern=r'U[0-9]+')
-
-# Bulk updates
-sch.components.bulk_update(
-    criteria={'lib_id': 'Device:R'},
-    updates={'properties': {'Tolerance': '1%'}}
-)
-
-# Component validation
-validation_result = sch.components.validate_component(
-    'Device:R', 
-    'Resistor_SMD:R_0603_1608Metric'
-)
-```
-
-### KiCAD Integration
-
-```python
-# Run electrical rules check using KiCAD CLI
-erc_result = sch.run_erc_check()
-print(f"ERC Status: {erc_result.status}")
-for violation in erc_result.violations:
-    print(f"- {violation.type}: {violation.message}")
-
-# Generate netlist for connectivity analysis
-netlist = sch.generate_netlist()
-net_info = netlist.analyze_net("VCC")
-```
-
-## 🤖 AI Agent Integration (MCP Server)
-
-Use with Claude Code or other AI agents via Model Context Protocol:
-
-### Setup MCP Server
-
-```bash
-# Install MCP server
-pip install kicad-sch-api[mcp]
-
-# Configure for Claude Code (automatic)
-kicad-sch-api --setup-claude-code
-```
-
-### Usage with AI Agents
-
-```
-# Natural language commands to your AI agent:
-"Create a voltage divider with two 10kΩ resistors"
-"Add an ESP32 microcontroller with USB connector" 
-"Generate a hierarchical schematic with power supply subcircuit"
-```
-
-The AI agent will use the MCP server to:
-1. Create professional schematics with proper component references
-2. Use hierarchical labels instead of messy wires
-3. Apply KiCAD design best practices automatically
-4. Generate clean, industry-standard layouts
-
-### Available MCP Tools
-
-| Tool | Description |
-|------|-------------|
-| `create_schematic` | Create new schematic files |
-| `add_component` | Add components with validation |
-| `search_components` | Find components in KiCAD libraries |
-| `add_hierarchical_sheet` | Create multi-sheet designs |
-| `validate_component` | Check component/footprint compatibility |
-| `list_components` | Get all components in schematic |
-| `save_schematic` | Save with exact format preservation |
-
-## 🏗️ Architecture
-
-### Library Structure
-
-```
-kicad_sch_api/
-├── core/              # Core schematic manipulation
-├── library/           # KiCAD library integration
-├── integration/       # KiCAD CLI and tool integration
-├── mcp/              # MCP server for AI agents
-└── utils/            # Validation and utilities
-```
-
-### Design Principles
-
-- **Building Block First**: Designed to be the foundation for other tools
-- **Exact Format Preservation**: Guaranteed byte-perfect KiCAD output
-- **Professional Quality**: Comprehensive error handling and validation
-- **AI-Native**: Built specifically for AI agent integration
-- **Performance Optimized**: Fast operations on large schematics
-
-## 🧪 Testing & Quality
-
-```bash
-# Run all tests
-uv run pytest tests/ -v
-
-# Format preservation tests (critical)
-uv run pytest tests/reference_tests/ -v
-
-# Code quality checks
-uv run black kicad_sch_api/ tests/
-uv run mypy kicad_sch_api/
-uv run flake8 kicad_sch_api/ tests/
-```
-
-## 🆚 Why This Library?
-
-### vs. Direct KiCAD File Editing
-- **Professional API**: High-level operations vs low-level S-expression manipulation
-- **Guaranteed Format**: Byte-perfect output vs manual formatting
-- **Validation**: Real KiCAD library integration and component validation
-- **Performance**: Optimized collections vs manual iteration
-
-### vs. Other Python KiCAD Libraries
-- **Format Preservation**: Exact KiCAD compatibility vs approximate output
-- **Modern Design**: Object-oriented collections vs legacy patterns
-- **AI Integration**: Purpose-built MCP server vs no agent support
-- **Professional Focus**: Production-ready vs exploration tools
-
-## 🔗 Ecosystem
-
-This library is designed as a building block for specialized tools:
-
-```python
-# Foundation library
-import kicad_sch_api as ksa
-
-# Specialized libraries (examples of what could be built)
-# import kicad_sourcing_tools as sourcing      # Component sourcing
-# import kicad_placement_optimizer as placement # Layout optimization  
-# import kicad_dfm_checker as dfm              # Manufacturing validation
-
-# Foundation provides reliable schematic manipulation
-sch = ksa.load_schematic('project.kicad_sch')
-
-# Specialized tools extend functionality
-# sourcing.update_component_sourcing(sch.components)
-# placement.optimize_layout(sch)
-# dfm.check_manufacturing_rules(sch)
-
-# All save through foundation's format preservation
-sch.save()  # Guaranteed exact KiCAD format
-```
-
-## 📖 Documentation
-
-- **[API Reference](docs/api.md)**: Complete API documentation
-- **[Examples](examples/)**: Code examples and tutorials
-- **[MCP Integration](docs/mcp.md)**: AI agent integration guide
-- **[Development](docs/development.md)**: Contributing and development setup
-
-## 🤝 Contributing
-
-We welcome contributions! Key areas:
-
-- KiCAD library integration and component validation
-- Performance optimizations for large schematics  
-- Additional MCP tools for AI agents
-- Test coverage and format preservation validation
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
-
-## 📄 License
-
-MIT License - see [LICENSE](LICENSE) for details.
-
-## 🔗 Related Projects
-
-- **[circuit-synth](https://github.com/circuit-synth/circuit-synth)**: High-level circuit design automation using this library
-- **[Claude Code](https://claude.ai/code)**: AI development environment with MCP support
-- **[KiCAD](https://kicad.org/)**: Open source electronics design automation suite
-
----
-
-**Professional KiCAD schematic manipulation for the AI age ⚡**

kicad_sch_api-0.1.7.dist-info/RECORD

@@ -1,26 +0,0 @@
-kicad_sch_api/__init__.py,sha256=mogTeOic6O-WWOfpoRuBzPicVNha-gbdMrhJX4ir5PY,2821
-kicad_sch_api/cli.py,sha256=zBu5939tFxBkHDireUpKUi73G2VG75qZacsWhsZz9Ro,14247
-kicad_sch_api/py.typed,sha256=e4ldqxwpY7pNDG1olbvj4HSKr8sZ9vxgA_2ek8xXn-Q,70
-kicad_sch_api/core/__init__.py,sha256=ur_KeYBlGKl-e1hLpLdxAhGV2A-PCCGkcqd0r6KSeBA,566
-kicad_sch_api/core/components.py,sha256=TiQrl7jdDTnuCWKdrlQC8-3b9PU58KoxTTnPX6VyZZk,24759
-kicad_sch_api/core/formatter.py,sha256=kvKbuVLkZOV7iyEmzAeFvxnOd4FpQ-7dwG8rvyTrXss,14346
-kicad_sch_api/core/ic_manager.py,sha256=5pw0FtUBXeF6afbiYej7kQe6ga32N4bNTScEHWYGq7A,7298
-kicad_sch_api/core/junctions.py,sha256=p99iv8pBb-3oktVsTeHgjl7QkkZa9EeN32nSy4g23o4,6251
-kicad_sch_api/core/parser.py,sha256=s1NwkuhouOplsBy-yZ_6RISmlunhWqRlD_8aNxIpYdU,44741
-kicad_sch_api/core/schematic.py,sha256=EHofbbfZfBfDcdHNNsO9peNNu3Iq07m2g_xQjL41p20,45972
-kicad_sch_api/core/types.py,sha256=I56eG0G8C4t9OaMiTcbxn6-xivwjpP5EXZUHnDoB6mY,12853
-kicad_sch_api/core/wires.py,sha256=kvANBg79KxOd5TKZNpHbjMyouZbGwRKLPNz4ePvvHgk,8207
-kicad_sch_api/discovery/__init__.py,sha256=0ky_FT58x-6aez6R9nhH2BBV27yG1N8EutRbRu7USxo,328
-kicad_sch_api/discovery/search_index.py,sha256=Yl3PXRk19mXCDtABM6Bs0ii0HMGiUAmIpD7xZjt7oEU,15943
-kicad_sch_api/library/__init__.py,sha256=NG9UTdcpn25Bl9tPsYs9ED7bvpaVPVdtLMbnxkQkOnU,250
-kicad_sch_api/library/cache.py,sha256=NPJT-apWH_JfVG1aXJ0gDnfGu8es_2tYiyZr-chcTxY,33511
-kicad_sch_api/mcp/__init__.py,sha256=Jw4gKdn9H-2MVUYBTIAb6s5Tz2mYc9KoQPRsx-voD4s,159
-kicad_sch_api/mcp/server.py,sha256=OB79fTR0lZubxC1jm0Avib37Zv_-nqZPl4XrrL_qO4c,54445
-kicad_sch_api/utils/__init__.py,sha256=1V_yGgI7jro6MUc4Pviux_WIeJ1wmiYFID186SZwWLQ,277
-kicad_sch_api/utils/validation.py,sha256=XlWGRZJb3cOPYpU9sLQQgC_NASwbi6W-LCN7PzUmaPY,15626
-kicad_sch_api-0.1.7.dist-info/licenses/LICENSE,sha256=Em65Nvte1G9MHc0rHqtYuGkCPcshD588itTa358J6gs,1070
-kicad_sch_api-0.1.7.dist-info/METADATA,sha256=kbs3QfDqzcDwbRrrk133KSJz-by8LTdO8qpcJPHafWw,10566
-kicad_sch_api-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kicad_sch_api-0.1.7.dist-info/entry_points.txt,sha256=Ibo-83_EdwmiuQwMcOHEzClKgl8MC9syASWtYzeD-os,103
-kicad_sch_api-0.1.7.dist-info/top_level.txt,sha256=n0ex4gOJ1b_fARowcGqRzyOGZcHRhc5LZa6_vVgGxcI,14
-kicad_sch_api-0.1.7.dist-info/RECORD,,