feat: add examples for basic usage, proxy API, and unify API

Author: sonnyt

README.md

@@ -11,6 +11,7 @@ Official Python SDK for the [BundleUp](https://bundleup.io) API. Connect to 100+
 - [Installation](#installation)
 - [Requirements](#requirements)
 - [Features](#features)
+- [Examples](#examples)
 - [Quick Start](#quick-start)
 - [Authentication](#authentication)
 - [Core Concepts](#core-concepts)
@@ -76,6 +77,15 @@ The BundleUp SDK is tested and supported on:
 - 🔍 **Type Hints** - Full type annotations for better IDE support
 - 🧪 **Tested** - Comprehensive test suite with pytest
 
+## Examples
+
+Runnable examples are available in the [`examples/`](./examples) directory:
+
+- [`examples/basic_usage.py`](./examples/basic_usage.py) - Client setup, connections, integrations, and webhooks
+- [`examples/proxy_api.py`](./examples/proxy_api.py) - Proxy API GET request with a connection
+- [`examples/unify_api.py`](./examples/unify_api.py) - Unify Chat, Git, and PM endpoint usage
+- [`examples/README.md`](./examples/README.md) - Setup and execution instructions
+
 ## Quick Start
 
 Get started with BundleUp in just a few lines of code:

examples/README.md

@@ -0,0 +1,29 @@
+# BundleUp Python SDK Examples
+
+This folder contains runnable scripts that show common SDK workflows.
+
+## Prerequisites
+
+- Python 3.8+
+- `pip install -r requirements.txt` run from `bundleup-sdk-python/`
+- `BUNDLEUP_API_KEY` set in your environment
+
+For examples that use a connected integration, also set:
+
+- `BUNDLEUP_CONNECTION_ID`
+
+## Run an Example
+
+From `bundleup-sdk-python/`:
+
+```bash
+python examples/basic_usage.py
+python examples/proxy_api.py
+python examples/unify_api.py
+```
+
+## Scripts
+
+- `basic_usage.py` — initialize the SDK and list connections, integrations, and webhooks
+- `proxy_api.py` — send a GET request through the Proxy API
+- `unify_api.py` — call Unify Chat, Git, and PM endpoints

examples/basic_usage.py

@@ -0,0 +1,30 @@
+import os
+
+from bundleup import BundleUp
+
+api_key = os.getenv("BUNDLEUP_API_KEY")
+
+if not api_key:
+    raise SystemExit("BUNDLEUP_API_KEY is required")
+
+client = BundleUp(api_key)
+
+print("BundleUp Python SDK: basic usage")
+
+try:
+    connections = client.connection.list()
+    print(f"Connections: {len(connections)}")
+except Exception as error:
+    print(f"Failed to list connections: {error}")
+
+try:
+    integrations = client.integration.list()
+    print(f"Integrations: {len(integrations)}")
+except Exception as error:
+    print(f"Failed to list integrations: {error}")
+
+try:
+    webhooks = client.webhook.list()
+    print(f"Webhooks: {len(webhooks)}")
+except Exception as error:
+    print(f"Failed to list webhooks: {error}")

examples/proxy_api.py

@@ -0,0 +1,25 @@
+import os
+
+from bundleup import BundleUp
+
+api_key = os.getenv("BUNDLEUP_API_KEY")
+connection_id = os.getenv("BUNDLEUP_CONNECTION_ID")
+path = os.getenv("BUNDLEUP_PROXY_PATH", "/users")
+
+if not api_key:
+    raise SystemExit("BUNDLEUP_API_KEY is required")
+
+if not connection_id:
+    raise SystemExit("BUNDLEUP_CONNECTION_ID is required for proxy example")
+
+client = BundleUp(api_key)
+proxy = client.proxy(connection_id)
+
+print(f"Proxy GET {path}")
+
+try:
+    response = proxy.get(path)
+    print(f"Status: {response.status_code}")
+    print(f"Body: {response.text}")
+except Exception as error:
+    print(f"Proxy request failed: {error}")

examples/unify_api.py

@@ -0,0 +1,35 @@
+import os
+
+from bundleup import BundleUp
+
+api_key = os.getenv("BUNDLEUP_API_KEY")
+connection_id = os.getenv("BUNDLEUP_CONNECTION_ID")
+
+if not api_key:
+    raise SystemExit("BUNDLEUP_API_KEY is required")
+
+if not connection_id:
+    raise SystemExit("BUNDLEUP_CONNECTION_ID is required for unify example")
+
+client = BundleUp(api_key)
+unify = client.unify(connection_id)
+
+print("Unify API example")
+
+try:
+    channels = unify.chat.channels({"limit": 10})
+    print(f"Chat channels: {len(channels.get('data', []))}")
+except Exception as error:
+    print(f"Failed to fetch chat channels: {error}")
+
+try:
+    repos = unify.git.repos({"limit": 10})
+    print(f"Git repos: {len(repos.get('data', []))}")
+except Exception as error:
+    print(f"Failed to fetch git repos: {error}")
+
+try:
+    issues = unify.pm.issues({"limit": 10})
+    print(f"PM issues: {len(issues.get('data', []))}")
+except Exception as error:
+    print(f"Failed to fetch PM issues: {error}")