kcaa 0.1.0__tar.gz

kcaa-0.1.0/.env.example

@@ -0,0 +1,27 @@
+# Example environment file for KiCad MCP Server
+# Copy this file to .env and customize the values
+
+# Additional directories to search for KiCad projects (comma-separated)
+# KICAD_SEARCH_PATHS=~/pcb,~/Electronics,~/Projects/KiCad
+
+# Override the default KiCad user directory
+# KICAD_USER_DIR=~/Documents/KiCad
+
+# Override the default KiCad application path 
+# macOS:
+# KICAD_APP_PATH=/Applications/KiCad/KiCad.app
+# Windows:
+# KICAD_APP_PATH=C:\Program Files\KiCad
+# Linux:
+# KICAD_APP_PATH=/usr/share/kicad
+
+# MCP server transport protocol
+# Supported values: stdio (default), streamable-http, sse
+# MCP_TRANSPORT=stdio
+
+# KiCad version (used to build versioned directory paths)
+# KICAD_VERSION=9.0
+
+# KiCad symbol library paths (defaults are derived from KICAD_VERSION)
+# KICAD_3RD_PARTY=~/.local/share/kicad/9.0/3rdparty
+# KICAD_CONFIG_DIR=~/.config/kicad/9.0

kcaa-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+## Bug Description
+<!-- A clear and concise description of the bug -->
+
+## Environment
+- Operating System: <!-- e.g., macOS 13.4, Windows 11, Ubuntu 22.04 -->
+- Python Version: <!-- e.g., 3.10.5 -->
+- KiCad Version: <!-- e.g., 9.0.2 -->
+- MCP Client: <!-- e.g., Claude Desktop, custom client -->
+- KiCad MCP Server Version/Commit: <!-- e.g., v0.1.0, commit hash -->
+
+## Steps to Reproduce
+<!-- Detailed steps to reproduce the bug -->
+1. 
+2. 
+3. 
+
+## Expected Behavior
+<!-- What you expected to happen -->
+
+## Actual Behavior
+<!-- What actually happened, including any error messages, logs, or screenshots -->
+
+## Logs
+<!-- If applicable, include relevant log output. You can find logs at:
+     - On macOS: ~/Library/Logs/Claude/mcp-server-kicad.log
+     - On Windows: [Path to logs]
+     - On Linux: [Path to logs] -->
+
+## Additional Context
+<!-- Any other information that might be relevant to the issue -->

kcaa-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature Request
+about: Suggest a new feature or enhancement for the KiCad MCP Server
+title: "[FEATURE] "
+labels: enhancement
+assignees: ''
+---
+
+## Feature Description
+<!-- A clear and concise description of the feature you'd like to see -->
+
+## Use Case
+<!-- Describe how this feature would be used and who would benefit from it -->
+
+## Proposed Implementation (optional)
+<!-- If you have ideas about how to implement this feature -->
+
+## Additional Context
+<!-- Any other information, screenshots, or examples that might be helpful -->

kcaa-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,46 @@
+---
+name: Pull Request
+about: Submit a pull request to contribute to the KiCad MCP Server
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
+<!-- Provide a detailed description of the changes in this PR -->
+
+## Related Issue(s)
+<!-- Link any related issues using the format: Fixes #123, Addresses #456 -->
+
+## Type of Change
+<!-- Mark the appropriate options with 'x' (e.g., [x]) -->
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code refactoring (no functional changes)
+- [ ] Other (please describe):
+
+## Testing Performed
+<!-- Describe the testing you've done -->
+- [ ] Added new unit tests
+- [ ] Manually tested on macOS
+- [ ] Manually tested on Windows
+- [ ] Manually tested on Linux
+- [ ] Integration tested with Claude Desktop or other MCP client
+
+## Screenshots/Output
+<!-- If applicable, add screenshots or output examples -->
+
+## Checklist
+<!-- Mark items with 'x' (e.g., [x]) -->
+- [ ] My code follows the project's coding style
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have updated the documentation to reflect my changes
+- [ ] My changes generate no new warnings or errors
+- [ ] I have checked that my changes work on all supported platforms
+- [ ] New and existing unit tests pass with my changes
+
+## Additional Notes
+<!-- Any other information that would be useful -->

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

@@ -0,0 +1,123 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint and Format
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Set up Python 3.12
+      run: |
+        uv python install 3.12
+        uv python pin 3.12
+
+    - name: Install dependencies
+      run: uv sync --group dev
+
+    - name: Lint with ruff
+      run: uv run ruff check kcaa/ tests/
+
+    - name: Check formatting with ruff
+      run: uv run ruff format --check kcaa/ tests/
+
+  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"]
+        exclude:
+          - os: macos-latest
+            python-version: "3.10"
+
+    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: |
+        uv python install ${{ matrix.python-version }}
+        uv python pin ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --group dev
+
+    - name: Run tests
+      run: uv run python -m pytest tests/ -v --cov=kcaa --cov-report=xml --cov-fail-under=30
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: false
+
+  security:
+    runs-on: ubuntu-latest
+    name: Security Scan
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Set up Python 3.12
+      run: |
+        uv python install 3.12
+        uv python pin 3.12
+
+    - name: Install dependencies
+      run: uv sync --group dev
+
+    - name: Run security scan
+      run: uv run bandit -r kcaa/
+
+  build:
+    runs-on: ubuntu-latest
+    name: Build Package
+    needs: [lint, test]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Set up Python 3.12
+      run: |
+        uv python install 3.12
+        uv python pin 3.12
+
+    - name: Build package
+      run: uv build
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/

kcaa-0.1.0/.gitignore

@@ -0,0 +1,83 @@
+# Virtual Environment
+venv/
+env/
+ENV/
+.venv/
+
+# Environment files
+.env
+
+# Python cache files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+*.whl
+
+# PyPI
+.pypirc
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.pytest_cache/
+MagicMock/
+
+# Logs
+logs/
+*.log
+
+# IDE specific files
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+
+# MCP specific
+~/.kcaa/drc_history/
+
+# Symbol database files (auto-generated, do not commit)
+kicad_mcp/utils/symbol_db/*.db
+kicad_mcp/utils/symbol_db/*.db-shm
+kicad_mcp/utils/symbol_db/*.db-wal
+
+# Footprint database files (auto-generated, do not commit)
+kicad_mcp/utils/footprint_db/*.db
+kicad_mcp/utils/footprint_db/*.db-shm
+kicad_mcp/utils/footprint_db/*.db-wal
+
+# UV and modern Python tooling
+uv.lock
+.uv-cache/
+.ruff_cache/
+
+# Pre-commit
+.pre-commit-config.yaml
+
+# KiCad backup files
+*-backups/
+fp-info-cache
+*.bak
+*.backup
+*.kicad_pcb-bak
+*.kicad_sch-bak
+*.kicad_pro-bak
+*.kicad_prl
+*.kicad_prl-bak
+*.kicad_sch.lck
+*.kicad_pcb.lck
+*.kicad_pro.lck

kcaa-0.1.0/.python-version

@@ -0,0 +1 @@
+3.10

kcaa-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lama Al Rajih
+
+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.

kcaa-0.1.0/Makefile

@@ -0,0 +1,81 @@
+.PHONY: help install test lint format clean build run dist-plugin
+
+help:
+	@echo "Available commands:"
+	@echo " 	install       		Install dependencies"
+	@echo " 	test          		Run tests"
+	@echo " 	test <file>   		Run specific test file"
+	@echo " 	lint          		Run linting"
+	@echo " 	format        		Format code"
+	@echo " 	clean         		Clean build artifacts"
+	@echo " 	build         		Build package"
+	@echo " 	run           		Start the KiCad MCP server"
+	@echo " 	dist-plugin   		Build installable KiCad plugin zip"
+
+install:
+	uv sync --group dev
+
+test:
+	# Collect extra args; if none, use tests/
+	@files="$(filter-out $@,$(MAKECMDGOALS))"; \
+	if [ -z "$$files" ]; then files="tests/"; fi; \
+	uv run pytest $$files -v
+
+# Prevent “No rule to make target …” errors for the extra args
+%::
+	@:
+
+lint:
+	uv run ruff check kcaa/ tests/
+	uv run mypy kcaa/
+
+format:
+	uv run ruff format kcaa/ tests/
+
+clean:
+	rm -rf dist/
+	rm -rf build/
+	rm -rf *.egg-info/
+	rm -rf .pytest_cache/
+	rm -rf htmlcov/
+	rm -f coverage.xml
+	find . -type d -name __pycache__ -delete
+	find . -type f -name "*.pyc" -delete
+
+build:
+	uv build
+
+run:
+	uv run python main.py
+
+# Build an installable KiCad plugin zip.
+# KiCad discovers plugins by looking for a directory named after the plugin
+# inside its scripting/plugins/ folder. The zip contains:
+#   kicad_ai_assistant/          <- KiCad plugin directory
+#     __init__.py                <- entry point (KiCadAIPlugin)
+#     context_bridge.py
+#     llm_client.py
+#     server_manager.py
+#     settings.py
+#     ui/
+#     README.md
+# Install: unzip into ~/.local/share/kicad/<ver>/scripting/plugins/
+#          then run from the plugin dir:
+#            ./setup_plugin.sh /path/to/kcaa
+#   setup_plugin.sh              <- creates .venv with kcaa installed
+PLUGIN_ZIP := dist/kicad_ai_assistant.zip
+PLUGIN_SRC := kicad_plugin
+
+dist-plugin:
+	@mkdir -p dist
+	@rm -f $(PLUGIN_ZIP)
+	@echo "Building $(PLUGIN_ZIP)..."
+	@rm -rf dist/_stage
+	@mkdir -p dist/_stage
+	@cp -r $(PLUGIN_SRC) dist/_stage/kicad_ai_assistant
+	@find dist/_stage -type d -name __pycache__ -exec rm -rf {} +
+	@find dist/_stage -type f -name "*.pyc" -delete
+	@cd dist/_stage && zip -r ../$(notdir $(PLUGIN_ZIP)) kicad_ai_assistant
+	@rm -rf dist/_stage
+	@echo "Created $(PLUGIN_ZIP)"
+