devrev-Python-SDK 2.0.0__tar.gz → 2.1.0__tar.gz

devrev_python_sdk-2.1.0/.augment/rules/devrev-sdk.md

@@ -0,0 +1,202 @@
+# DevRev SDK Usage Guidelines
+
+This rule file provides guidance for AI agents when generating code that uses the DevRev Python SDK.
+
+## Client Initialization
+
+### Environment Variables (Recommended)
+
+Always use environment variables for API tokens - never hardcode:
+
+```python
+# Correct - reads from DEVREV_API_TOKEN environment variable
+from devrev import DevRevClient
+
+client = DevRevClient()
+```
+
+### Context Managers
+
+Always use context managers for proper resource cleanup:
+
+```python
+from devrev import DevRevClient, AsyncDevRevClient
+
+# Sync client
+with DevRevClient() as client:
+    accounts = client.accounts.list()
+
+# Async client
+async with AsyncDevRevClient() as client:
+    accounts = await client.accounts.list()
+```
+
+### Configuration
+
+For custom configuration:
+
+```python
+import os
+from devrev import DevRevClient, DevRevConfig
+
+config = DevRevConfig(
+    api_token=os.environ["DEVREV_API_TOKEN"],
+    timeout=60,
+    max_retries=3
+)
+client = DevRevClient(config=config)
+```
+
+## Response Handling
+
+Response objects contain data in nested attributes - always access the correct attribute:
+
+```python
+from devrev import DevRevClient
+
+client = DevRevClient()
+
+# CORRECT
+accounts_response = client.accounts.list()
+for account in accounts_response.accounts:  # Note: .accounts
+    print(account.display_name)
+
+# CORRECT
+work_response = client.works.get(id="don:core:...")
+print(work_response.work.title)  # Note: .work
+
+# INCORRECT - This will fail
+# print(accounts_response.title)  # Wrong! Response is not the data
+```
+
+## Error Handling
+
+Always handle exceptions from `devrev.exceptions`:
+
+```python
+import time
+import logging
+from devrev import DevRevClient
+from devrev.exceptions import (
+    DevRevError,
+    NotFoundError,
+    ValidationError,
+    RateLimitError,
+)
+
+logger = logging.getLogger(__name__)
+client = DevRevClient()
+work_id = "don:core:dvrv-us-1:devo/1:work/123"  # Example work ID
+
+try:
+    work = client.works.get(id=work_id)
+except NotFoundError:
+    # Handle missing resource
+    pass
+except RateLimitError as e:
+    # Wait and retry
+    time.sleep(e.retry_after)
+except DevRevError as e:
+    # Log error details
+    logger.error(f"API error: {e.message}, status: {e.status_code}")
+```
+
+## Pagination
+
+DevRev uses cursor-based pagination - never use page numbers:
+
+```python
+from devrev import DevRevClient
+
+client = DevRevClient()
+
+# CORRECT - cursor-based pagination
+cursor = None
+all_items = []
+
+while True:
+    response = client.accounts.list(cursor=cursor, limit=50)
+    all_items.extend(response.accounts)
+    cursor = response.next_cursor
+    if not cursor:
+        break
+```
+
+## Creating Work Items
+
+Always use the `WorkType` enum and provide required fields:
+
+```python
+from devrev import DevRevClient
+from devrev.models import WorkType
+
+client = DevRevClient()
+
+# Creating a ticket (customer-facing)
+response = client.works.create(
+    type=WorkType.TICKET,
+    title="Descriptive title",
+    applies_to_part="don:core:dvrv-us-1:devo/1:part/1",  # Required
+    body="Detailed description"
+)
+
+# Creating an issue (internal)
+response = client.works.create(
+    type=WorkType.ISSUE,
+    title="Bug: Dashboard loading error",
+    applies_to_part="don:core:dvrv-us-1:devo/1:part/1",
+    body="Technical details..."
+)
+```
+
+## ID Format
+
+DevRev uses DON (DevRev Object Notation) IDs:
+
+```
+don:core:dvrv-us-1:devo/1:ticket/123
+don:core:dvrv-us-1:devo/1:part/456
+don:identity:dvrv-us-1:devo/1:devu/789
+```
+
+Never construct IDs manually - always use IDs returned from API responses.
+
+## Async Best Practices
+
+For concurrent operations, use `asyncio.gather`:
+
+```python
+import asyncio
+from devrev import AsyncDevRevClient
+
+async def fetch_data():
+    async with AsyncDevRevClient() as client:
+        # Parallel requests - much faster
+        accounts, works, users = await asyncio.gather(
+            client.accounts.list(limit=10),
+            client.works.list(limit=50),
+            client.dev_users.list()
+        )
+        return accounts, works, users
+```
+
+## Anti-Patterns to Avoid
+
+1. **Never hardcode API tokens** in source code
+2. **Never use page numbers** - use cursor-based pagination
+3. **Never access response data directly** - use the nested attribute
+4. **Never create clients without cleanup** - use context managers
+5. **Never ignore rate limits** - handle `RateLimitError` with retry
+6. **Never construct DON IDs** - always use IDs from API responses
+
+## Beta API
+
+For beta features, explicitly enable the beta API:
+
+```python
+from devrev import DevRevClient, APIVersion
+
+client = DevRevClient(api_version=APIVersion.BETA)
+# Now beta services are available: incidents, engagements, search, etc.
+```
+

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/.github/workflows/ci.yml

@@ -35,6 +35,9 @@ jobs:
       - name: Type check with mypy
         run: mypy src/
 
+      - name: Validate AI documentation
+        run: python scripts/build_ai_docs.py --verbose
+
       - name: Run tests (unit tests only)
         run: pytest --cov=src/devrev --cov-report=xml -v -m "not integration"
 

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devrev-Python-SDK
-Version: 2.0.0
+Version: 2.1.0
 Summary: A modern, type-safe Python SDK for the DevRev API
 Project-URL: Homepage, https://github.com/mgmonteleone/py-dev-rev
 Project-URL: Documentation, https://github.com/mgmonteleone/py-dev-rev
@@ -67,7 +67,8 @@ Description-Content-Type: text/markdown
 
 A modern, type-safe Python SDK for the DevRev API.
 
-[![PyPI Version](https://img.shields.io/pypi/v/py-devrev.svg)](https://pypi.org/project/py-devrev/)
+[![Built with Augment](https://img.shields.io/badge/Built%20with-Auggie-6366f1?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0xMiAyTDIgMTloMjBMMTIgMnptMCAzLjc1TDE4LjI1IDE3SDUuNzVMMTIgNS43NXoiLz48L3N2Zz4=)](https://www.augmentcode.com/)
+[![PyPI Version](https://img.shields.io/pypi/v/devrev-python-sdk.svg)](https://pypi.org/project/devrev-Python-SDK/)
 [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![Type Checked](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy-lang.org/)
 [![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
@@ -149,10 +150,10 @@ This SDK is generated and maintained from the official DevRev OpenAPI specificat
 
 ## Installation
 
-### From Google Artifact Registry (Recommended)
+### From PyPI (Recommended)
 
 ```bash
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 ### From Source

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/README.md

@@ -2,7 +2,8 @@
 
 A modern, type-safe Python SDK for the DevRev API.
 
-[![PyPI Version](https://img.shields.io/pypi/v/py-devrev.svg)](https://pypi.org/project/py-devrev/)
+[![Built with Augment](https://img.shields.io/badge/Built%20with-Auggie-6366f1?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0xMiAyTDIgMTloMjBMMTIgMnptMCAzLjc1TDE4LjI1IDE3SDUuNzVMMTIgNS43NXoiLz48L3N2Zz4=)](https://www.augmentcode.com/)
+[![PyPI Version](https://img.shields.io/pypi/v/devrev-python-sdk.svg)](https://pypi.org/project/devrev-Python-SDK/)
 [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![Type Checked](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy-lang.org/)
 [![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
@@ -84,10 +85,10 @@ This SDK is generated and maintained from the official DevRev OpenAPI specificat
 
 ## Installation
 
-### From Google Artifact Registry (Recommended)
+### From PyPI (Recommended)
 
 ```bash
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 ### From Source

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/SECURITY.md

@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 2.x.x   | :white_check_mark: |
 | 1.x.x   | :white_check_mark: |
 | < 1.0   | :x:                |
 

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/benchmarks/README.md

@@ -13,7 +13,7 @@ These benchmarks measure SDK performance in key areas:
 ## Requirements
 
 ```bash
-pip install py-devrev[benchmark]
+pip install devrev-python-sdk[benchmark]
 # or
 pip install pytest-benchmark
 ```

devrev_python_sdk-2.1.0/context7.json

@@ -0,0 +1,4 @@
+{
+  "url": "https://context7.com/mgmonteleone/py-dev-rev",
+  "public_key": "pk_l1A2MxJN3yeqqlT4vmfem"
+}

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/docs/getting-started/installation.md

@@ -12,7 +12,7 @@ This guide covers all methods for installing the DevRev Python SDK.
 The simplest way to install:
 
 ```bash
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 ## Installation Methods
@@ -20,7 +20,7 @@ pip install py-devrev
 ### Using pip (Recommended)
 
 ```bash
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 ### Using uv (Faster)
@@ -28,13 +28,13 @@ pip install py-devrev
 [uv](https://github.com/astral-sh/uv) is a fast Python package installer:
 
 ```bash
-uv pip install py-devrev
+uv pip install devrev-python-sdk
 ```
 
 ### Using Poetry
 
 ```bash
-poetry add py-devrev
+poetry add devrev-python-sdk
 ```
 
 ### Using pipx (For CLI tools)
@@ -42,7 +42,7 @@ poetry add py-devrev
 If you're using the SDK as a CLI tool:
 
 ```bash
-pipx install py-devrev
+pipx install devrev-python-sdk
 ```
 
 ## Development Installation
@@ -82,7 +82,7 @@ After installation, verify it works:
 ```python
 >>> import devrev
 >>> print(devrev.__version__)
-0.1.0
+2.0.0
 >>> from devrev import DevRevClient
 >>> # Success!
 ```
@@ -103,7 +103,7 @@ We recommend using virtual environments:
     python -m venv .venv
     source .venv/bin/activate  # Linux/macOS
     .venv\Scripts\activate     # Windows
-    pip install py-devrev
+    pip install devrev-python-sdk
     ```
 
 === "conda"
@@ -111,7 +111,7 @@ We recommend using virtual environments:
     ```bash
     conda create -n devrev python=3.11
     conda activate devrev
-    pip install py-devrev
+    pip install devrev-python-sdk
     ```
 
 === "pyenv + virtualenv"
@@ -120,7 +120,7 @@ We recommend using virtual environments:
     pyenv install 3.11.0
     pyenv virtualenv 3.11.0 devrev
     pyenv activate devrev
-    pip install py-devrev
+    pip install devrev-python-sdk
     ```
 
 ## Upgrading
@@ -128,7 +128,7 @@ We recommend using virtual environments:
 To upgrade to the latest version:
 
 ```bash
-pip install --upgrade py-devrev
+pip install --upgrade devrev-python-sdk
 ```
 
 ## Troubleshooting
@@ -161,12 +161,12 @@ If you get permission errors:
 
 ```bash
 # Use --user flag
-pip install --user py-devrev
+pip install --user devrev-python-sdk
 
 # Or use a virtual environment (recommended)
 python -m venv .venv
 source .venv/bin/activate
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 ## Next Steps

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/docs/index.md

@@ -1,5 +1,9 @@
 # DevRev Python SDK
 
+[![Built with Augment](https://img.shields.io/badge/Built%20with-Auggie-6366f1?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0xMiAyTDIgMTloMjBMMTIgMnptMCAzLjc1TDE4LjI1IDE3SDUuNzVMMTIgNS43NXoiLz48L3N2Zz4=)](https://www.augmentcode.com/)
+[![PyPI Version](https://img.shields.io/pypi/v/devrev-python-sdk.svg)](https://pypi.org/project/devrev-Python-SDK/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+
 A modern, type-safe Python SDK for the [DevRev API](https://devrev.ai).
 
 <div class="grid cards" markdown>
@@ -96,7 +100,7 @@ A modern, type-safe Python SDK for the [DevRev API](https://devrev.ai).
 ## Installation
 
 ```bash
-pip install py-devrev
+pip install devrev-python-sdk
 ```
 
 See the [Installation Guide](getting-started/installation.md) for more options.

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/examples/README.md

@@ -24,7 +24,7 @@ examples/
 
 1. **Install the SDK:**
    ```bash
-   pip install py-devrev
+   pip install devrev-python-sdk
    ```
 
 2. **Set your API token:**

{devrev_python_sdk-2.0.0 → devrev_python_sdk-2.1.0}/examples/basic/README.md

@@ -6,7 +6,7 @@ Simple examples demonstrating common DevRev SDK operations.
 
 1. Install the SDK:
    ```bash
-   pip install py-devrev
+   pip install devrev-python-sdk
    ```
 
 2. Set your API token: