PatchPilot

PatchPilot is an API-driven code generation and management system that helps you create, manage, and execute code patches. (my first fullstack CRUD application)

Setup Instructions

1. Clone the repository:

git clone https://github.com/abigaillhiggins/PatchPilot.git
cd PatchPilot

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Set up environment variables:

export OPENAI_API_KEY="your-api-key"  # Required for code generation
export DB_PATH="todos.db"  # Optional, defaults to todos.db

5. Run the server:

PYTHONPATH=. python run.py server --port 8002

The server will start on http://localhost:8002

API Endpoints

Git Operations

# Initialize Git Repository
curl -X POST http://localhost:8002/git/init

# Configure Git User
curl -X POST http://localhost:8002/git/config \
  -H "Content-Type: application/json" \
  -d '{"name": "Your Name", "email": "your.email@example.com"}'

# Add Remote
curl -X POST http://localhost:8002/git/remote \
  -H "Content-Type: application/json" \
  -d '{"name": "origin", "url": "https://github.com/username/repo.git"}'

# Create Commit
curl -X POST http://localhost:8002/git/commit \
  -H "Content-Type: application/json" \
  -d '{"message": "Your commit message", "files": ["path/to/file1", "path/to/file2"]}'

# Push Changes
curl -X POST http://localhost:8002/git/push \
  -H "Content-Type: application/json" \
  -d '{"remote": "origin", "branch": "main"}'

# Get Git Status
curl http://localhost:8002/git/status

# Push Specific Patch
curl -X POST http://localhost:8002/git/push-patch/{patch_id} \
  -H "Content-Type: application/json" \
  -d '{"commit_message": "Optional custom message", "remote": "origin", "branch": "main"}'

Todo Management

# Create Todo
curl -X POST http://localhost:8002/todos/ \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Task title",
    "description": "Task description",
    "language": "python",
    "requirements": ["Feature requirement 1", "Feature requirement 2"],
    "package_requirements": ["package1>=1.0.0", "package2>=2.0.0"],
    "context": "Additional context",
    "metadata": {"key": "value"}
  }'

# List All Todos
curl http://localhost:8002/todos/

# Complete Todo
curl -X PUT http://localhost:8002/todos/{todo_id}/complete

# Delete Todo
curl -X DELETE http://localhost:8002/todos/{todo_id}

# Search Todos
curl "http://localhost:8002/todos/search?query=your_search_term"

Code Generation and Execution

# Generate Code for Todo
curl -X POST http://localhost:8002/generate-code/{todo_id}

# Run Patch with Analysis
curl -X POST http://localhost:8002/run-patch/{todo_id}?analyze=true

# Execute Patch Directly
curl -X POST http://localhost:8002/execute-patch/ \
  -H "Content-Type: application/json" \
  -d '{"patch_id": "your_patch_id", "analyze": true}'

# Get Patch Status
curl http://localhost:8002/patch-status/{patch_id}

Response Models

All endpoints return JSON responses. Common response structures include:

• Success responses include a message field describing the operation result
• Error responses include a detail field describing what went wrong
• Patch execution responses include:
  • status: Current status of the execution
  • execution_output: Standard output from the execution
  • error_output: Standard error output if any
  • return_code: Execution return code
  • analysis: Optional analysis of the execution (if requested)
  • suggested_improvements: Optional suggestions for code improvement

Example Use Cases

Example 1: Creating a JSON Schema Validator

Here's a complete example of using PatchPilot to create and test a JSON schema validator:

1. Create a todo for the validator:

curl -X POST http://localhost:8002/todos/ \
  -H "Content-Type: application/json" \
  -d '{
    "title": "JSON Schema Validator",
    "description": "Create a function that validates a given JSON object against a schema",
    "language": "python",
    "requirements": [
      "Support nested objects",
      "Support array validation",
      "Support type validation"
    ],
    "package_requirements": ["jsonschema>=4.0.0"],
    "context": "We need a reusable validation function",
    "metadata": {
      "type": "utility",
      "priority": "high"
    }
  }'

Response:

{
  "id": 3,
  "title": "JSON Schema Validator",
  "description": "Create a function that validates a given JSON object against a schema",
  "completed": false,
  "created_at": "2025-07-08T15:52:48.402915",
  "language": "python",
  "requirements": ["Support nested objects", "Support array validation", "Support type validation"],
  "context": "We need a reusable validation function",
  "metadata": {"type": "utility", "priority": "high"},
  "patch_id": null
}

2. Generate code for the todo:

curl -X POST http://localhost:8002/generate-code/3

The generated code will include:

• Type validation for different JSON types (object, array, string, number, boolean)
• Support for nested object validation
• Array validation with item type checking
• Required field validation
• A comprehensive example showing how to use the validator

Example 2: Creating a String Utility

Here's another example of using PatchPilot to create and test a string utility function:

1. Create a todo for the string utility:

curl -X POST http://localhost:8002/todos/ \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Create String Reversal Utility",
    "description": "Create a Python function that can reverse strings and check for palindromes",
    "language": "python",
    "requirements": [
      "Handle empty strings",
      "Support special characters",
      "Case-sensitive palindrome check"
    ],
    "package_requirements": [],
    "context": "The function should handle empty strings and special characters correctly"
  }'

2. Generate code for the todo:

curl -X POST http://localhost:8002/generate-code/1

3. Run and analyze the generated code:

curl -X POST http://localhost:8002/run-patch/1?analyze=true

4. Check execution status:

curl http://localhost:8002/patch-status/20250707_134732_create_a_python_function_that_reverses_a_string

5. If satisfied with the results, commit the patch:

curl -X POST http://localhost:8002/git/push-patch/20250707_134732_create_a_python_function_that_reverses_a_string \
  -H "Content-Type: application/json" \
  -d '{
    "commit_message": "Add string reversal utility with palindrome check",
    "branch": "feature/string-utils"
  }'

The generated code will be saved in the patches directory, tested, analyzed for potential improvements, and can be committed to your repository. PatchPilot handles all the boilerplate of creating, testing, and managing the code changes.