Merge pull request #20 from laurigates/pr-2-infrastructure-ci-cd

Development Infrastructure & CI/CD

Author: lamaalrajih

.github/workflows/ci.yml

@@ -0,0 +1,97 @@
+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 kicad_mcp/ tests/
+
+    - name: Check formatting with ruff
+      run: uv run ruff format --check kicad_mcp/ tests/
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+
+    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=kicad_mcp --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
+
+  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/

.gitignore

@@ -33,6 +33,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
+.pytest_cache/
 
 # Logs
 logs/
@@ -47,3 +48,25 @@ logs/
 
 # MCP specific
 ~/.kicad_mcp/drc_history/
+
+# 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

Makefile

@@ -0,0 +1,39 @@
+.PHONY: help install test lint format clean build run
+
+help:
+	@echo "Available commands:"
+	@echo "  install     Install dependencies"
+	@echo "  test        Run tests"
+	@echo "  lint        Run linting"
+	@echo "  format      Format code"
+	@echo "  clean       Clean build artifacts"
+	@echo "  build       Build package"
+
+install:
+	uv sync --group dev
+
+test:
+	uv run python -m pytest tests/ -v
+
+lint:
+	uv run ruff check kicad_mcp/ tests/
+	uv run mypy kicad_mcp/
+
+format:
+	uv run ruff format kicad_mcp/ 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

README.md

@@ -22,6 +22,7 @@ This guide will help you set up a Model Context Protocol (MCP) server for KiCad.
 - macOS, Windows, or Linux
 - Python 3.10 or higher
 - KiCad 9.0 or higher
+- uv 0.8.0 or higher
 - Claude Desktop (or another MCP client)
 
 ## Installation Steps
@@ -32,14 +33,15 @@ First, let's install dependencies and set up our environment:
 
 ```bash
 # Clone the repository
-git clone https://github.com/lamaalrajih/kicad-mcp.git .
+git clone https://github.com/lamaalrajih/kicad-mcp.git
+cd kicad-mcp
 
-# Create a virtual environment and activate it
-python3 -m venv venv
-source venv/bin/activate  # On Windows: venv\Scripts\activate
+# Install dependencies – `uv` will create a `.venv/` folder automatically
+# (Install `uv` first: `brew install uv` on macOS or `pipx install uv`)
+make install
 
-# Install the MCP SDK and other dependencies
-pip install -r requirements.txt
+# Optional: activate the environment for manual commands
+source .venv/bin/activate
 ```
 
 ### 2. Configure Your Environment
@@ -89,7 +91,7 @@ vim ~/Library/Application\ Support/Claude/claude_desktop_config.json
 {
     "mcpServers": {
         "kicad": {
-            "command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/venv/bin/python",
+            "command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/.venv/bin/python",
             "args": [
                 "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/main.py"
             ]

pyproject.toml

@@ -14,8 +14,8 @@ authors = [
 requires-python = ">=3.10"
 dependencies = [
     "mcp[cli]>=1.0.0",
-    "fastmcp>=0.1.0",
     "pandas>=2.0.0",
+    "fastmcp>=2.0.0",
 ]
 classifiers = [
   "Programming Language :: Python :: 3",
@@ -41,8 +41,50 @@ kicad-mcp = "kicad_mcp.server:main"
 dev = [
     "pytest>=7.0.0",
     "pytest-asyncio>=0.23.0",
+    "pytest-mock>=3.10.0",
+    "pytest-cov>=4.0.0",
+    "pytest-xdist>=3.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.8.0",
+    "pre-commit>=3.0.0",
 ]
 
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501",  # line too long, handled by ruff format
+    "B008",  # do not perform function calls in argument defaults
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--cov=kicad_mcp",
+    "--cov-report=term-missing",
+    "--cov-report=html:htmlcov",
+    "--cov-report=xml",
+    "--cov-fail-under=30",
+]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["kicad_mcp*"]

requirements.txt

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+"""
+Test runner for KiCad MCP project.
+"""
+import subprocess
+import sys
+from pathlib import Path
+
+
+def run_command(cmd: list[str], description: str) -> int:
+    """Run a command and return the exit code."""
+    print(f"\n🔍 {description}")
+    print(f"Running: {' '.join(cmd)}")
+
+    try:
+        result = subprocess.run(cmd, check=False)
+        if result.returncode == 0:
+            print(f"✅ {description} passed")
+        else:
+            print(f"❌ {description} failed with exit code {result.returncode}")
+        return result.returncode
+    except FileNotFoundError:
+        print(f"❌ Command not found: {cmd[0]}")
+        return 1
+
+
+def main():
+    """Run all tests and checks."""
+    project_root = Path(__file__).parent
+
+    # Change to project directory
+    import os
+
+    os.chdir(project_root)
+
+    exit_code = 0
+
+    # Run linting
+    exit_code |= run_command(["uv", "run", "ruff", "check", "kicad_mcp/", "tests/"], "Lint check")
+
+    # Run formatting check
+    exit_code |= run_command(
+        ["uv", "run", "ruff", "format", "--check", "kicad_mcp/", "tests/"], "Format check"
+    )
+
+    # Run type checking
+    exit_code |= run_command(["uv", "run", "mypy", "kicad_mcp/"], "Type check")
+
+    # Run tests
+    exit_code |= run_command(["uv", "run", "python", "-m", "pytest", "tests/", "-v"], "Unit tests")
+
+    if exit_code == 0:
+        print("\n🎉 All checks passed!")
+    else:
+        print(f"\n💥 Some checks failed (exit code: {exit_code})")
+
+    return exit_code
+
+
+if __name__ == "__main__":
+    sys.exit(main())