Fix formatting issues to pass pre-commit checks

Author: codegen-sh[bot]

PLAN/PLAN.md

@@ -1,40 +1,48 @@
 # Project Plan for codegen
 
 ## Overview
+
 This project plan outlines the development roadmap for codegen.
 
 ## Objectives
+
 - Define project scope and requirements
 - Create implementation plan
 - Set milestones and deliverables
 - Assign responsibilities
 
 ## Requirements
+
 - [Requirement 1]
 - [Requirement 2]
 - [Requirement 3]
 
 ## Implementation Plan
+
 - [Step 1]
 - [Step 2]
 - [Step 3]
 
 ## Timeline
-- [Milestone 1]: [Date]
-- [Milestone 2]: [Date]
-- [Milestone 3]: [Date]
+
+-
+-
+-
 
 ## Resources
+
 - [Resource 1]
 - [Resource 2]
 - [Resource 3]
 
 ## Risks and Mitigations
-- [Risk 1]: [Mitigation Strategy]
-- [Risk 2]: [Mitigation Strategy]
-- [Risk 3]: [Mitigation Strategy]
+
+- \[Risk 1\]: [Mitigation Strategy]
+- \[Risk 2\]: [Mitigation Strategy]
+- \[Risk 3\]: [Mitigation Strategy]
 
 ## Team
-- [Team Member 1]: [Role]
-- [Team Member 2]: [Role]
-- [Team Member 3]: [Role]
+
+-
+-
+-

codegen-examples/examples/linear_webhooks/README.md

@@ -1,136 +1,135 @@
 # Linear Webhooks Example
 
-This example demonstrates how to set up a webhook handler for Linear events using the Codegen SDK and Modal. The webhook handler can process events from Linear such as issue creation, updates, comments, and more.
+This example demonstrates how to handle Linear webhook events using the Codegen SDK and Modal. It provides a simple webhook handler that processes different types of Linear events, such as Issue and Comment events.
+
+## Features
+
+- Receive and process Linear webhook events
+- Handle specific event types (Issues, Comments)
+- Deploy as a serverless application using Modal
+- Secure webhook verification using Linear's signing secret
 
 ## Prerequisites
 
-- [Modal](https://modal.com/) account
-- [Linear](https://linear.app/) account with admin access
 - Python 3.13 or higher
+- A Linear account with admin access
+- A Modal account (for deployment)
+- Codegen SDK (version 0.26.3 or higher)
 
 ## Setup
 
-### 1. Install Dependencies
+### 1. Clone the Repository
 
 ```bash
-# Clone the repository
-git clone https://github.com/Zeeeepa/codegen.git
-cd codegen/codegen-examples/examples/linear_webhooks
-
-# Install dependencies
-pip install -e .
+git clone https://github.com/your-username/your-repo.git
+cd your-repo/examples/linear_webhooks
 ```
 
-### 2. Configure Environment Variables
-
-Copy the `.env.template` file to `.env` and fill in your credentials:
+### 2. Create a Virtual Environment
 
 ```bash
-cp .env.template .env
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
 ```
 
-Edit the `.env` file with your Linear API credentials:
+### 3. Install Dependencies
 
-```
-LINEAR_ACCESS_TOKEN="your_linear_api_token"
-LINEAR_SIGNING_SECRET="your_linear_webhook_signing_secret"
-LINEAR_TEAM_ID="your_linear_team_id"
-MODAL_API_KEY="your_modal_api_key"  # Optional
+```bash
+pip install -e ".[dev]"
 ```
 
-To get these credentials:
+### 4. Set Up Environment Variables
 
-- **LINEAR_ACCESS_TOKEN**: Go to Linear → Settings → API → Create Key
-- **LINEAR_SIGNING_SECRET**: Created when you set up a webhook in Linear
-- **LINEAR_TEAM_ID**: Found in Linear team settings or via the API
-- **MODAL_API_KEY**: Your Modal API key (if not using Modal CLI authentication)
+Create a `.env` file in the project root with the following variables:
 
-### 3. Authenticate with Modal
-
-```bash
-modal token new
+```
+LINEAR_API_KEY=your_linear_api_key
+LINEAR_SIGNING_SECRET=your_linear_webhook_signing_secret
+MODAL_API_KEY=your_modal_api_key
 ```
 
-## Deployment Commands
+You can get your Linear API key from the Linear dashboard under Settings > API > Personal API Keys.
 
-### Deploy to Modal
+## Local Development
+
+For local development and testing, you can run the webhook handler locally:
 
 ```bash
-# Deploy the webhook handler to Modal
 python webhooks.py
 ```
 
-This will deploy the webhook handler to Modal and provide you with a URL that you can use to configure the webhook in Linear.
+This will start a local server that you can use for testing. However, for Linear to send webhooks to your local machine, you'll need to use a tool like ngrok to expose your local server to the internet.
 
-### Get Deployment Status
+## Deployment
 
-```bash
-# Check the status of your Modal deployment
-modal app status linear-webhooks
-```
+### Deploy to Modal
 
-### View Logs
+To deploy the webhook handler to Modal, run:
 
 ```bash
-# View logs from your Modal deployment
-modal app logs linear-webhooks
+modal deploy webhooks.py
 ```
 
-### Update Deployment
+This will deploy the webhook handler to Modal and provide you with a URL that you can use to configure the Linear webhook.
+
+### Update the Deployment
+
+To update an existing deployment:
 
 ```bash
-# Update your Modal deployment after making changes
-python webhooks.py
+modal deploy webhooks.py
 ```
 
-### Stop Deployment
+### Stop the Deployment
+
+To stop the deployment:
 
 ```bash
-# Stop your Modal deployment
 modal app stop linear-webhooks
 ```
 
 ## Configuring Linear Webhooks
 
 1. Go to Linear → Settings → API → Webhooks
-2. Click "New Webhook"
-3. Enter the URL provided by Modal when you deployed the webhook handler
-4. Select the events you want to receive (e.g., Issues, Comments)
-5. Copy the signing secret and add it to your `.env` file as `LINEAR_SIGNING_SECRET`
-6. Click "Create Webhook"
+1. Click "New Webhook"
+1. Enter the URL provided by Modal when you deployed the webhook handler
+1. Select the events you want to receive (e.g., Issues, Comments)
+1. Copy the signing secret and add it to your `.env` file as `LINEAR_SIGNING_SECRET`
+1. Click "Create Webhook"
 
 ## Customizing Event Handlers
 
-The example includes handlers for Issue and Comment events. You can customize these handlers or add new ones by modifying the `webhooks.py` file:
+You can customize the event handlers in `webhooks.py` to handle different types of Linear events. The example includes handlers for Issue and Comment events, but you can add handlers for other event types as well.
+
+To add a new event handler, add a new method to the `LinearEventHandlers` class and decorate it with `@app.linear.event("EventType")`:
 
 ```python
-@modal.web_endpoint(method="POST")
-@app.linear.event("YourEventType")
-def handle_your_event(self, event: LinearEvent):
+@app.linear.event("Project")
+def handle_project(self, event: LinearEvent):
+    """Handle Linear Project events"""
+    logger.info(f"Received Linear Project event: {event.action}")
     # Process the event
-    return {"status": "success"}
+    return {"status": "success", "message": f"Processed Linear Project event: {event.action}"}
 ```
 
-## Available Event Types
-
-Linear supports the following event types:
-
-- `Issue`
-- `Comment`
-- `Project`
-- `Cycle`
-- `Reaction`
-- And more...
+## Event Types
 
-Refer to the [Linear API documentation](https://developers.linear.app/docs/graphql/webhooks) for a complete list of event types.
+Linear supports various event types, including:
 
-## Troubleshooting
+- Issue
+- Comment
+- Project
+- Cycle
+- Team
+- User
+- Attachment
+- Reaction
+- Label
+- State
 
-- **Webhook not receiving events**: Verify that your Linear webhook is configured correctly and that the URL is accessible.
-- **Authentication errors**: Check that your LINEAR_ACCESS_TOKEN and LINEAR_SIGNING_SECRET are correct.
-- **Modal deployment issues**: Run `modal app logs linear-webhooks` to view logs and diagnose issues.
+Refer to the [Linear API documentation](https://developers.linear.app/docs/graphql/webhooks) for a complete list of event types and their payloads.
 
-## Additional Resources
+## Resources
 
 - [Codegen Documentation](https://docs.codegen.sh/)
 - [Modal Documentation](https://modal.com/docs)

codegen-examples/examples/linear_webhooks/pyproject.toml

@@ -1,21 +1,16 @@
 [project]
-name = "linear-webhook-example"
+name = "linear-webhooks"
 version = "0.1.0"
 description = "Linear webhook example for Codegen"
 requires-python = ">=3.13"
 dependencies = [
-    "codegen>=0.26.3", 
-    "modal>=0.73.25",
-    "fastapi>=0.110.0",
-    "uvicorn>=0.27.0",
-    "pydantic>=2.0.0"
+  "codegen>=0.26.3",
+  "modal>=0.73.25",
+  "fastapi>=0.110.0",
+  "uvicorn>=0.27.0",
+  "pydantic>=2.0.0",
 ]
 
 [project.optional-dependencies]
-dev = [
-    "black>=23.0.0",
-    "isort>=5.12.0",
-    "mypy>=1.0.0",
-    "ruff>=0.0.270"
-]
+dev = ["black>=23.0.0", "isort>=5.12.0", "mypy>=1.0.0", "ruff>=0.0.270"]