devrev-Python-SDK 2.8.0__tar.gz → 2.8.1__tar.gz

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/.github/workflows/ci.yml

@@ -39,7 +39,7 @@ jobs:
         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"
+        run: pytest --cov=src/devrev --cov-report=xml -v -m "not integration" --ignore=tests/performance
 
       - name: Run integration tests (if API token available)
         env:

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/.github/workflows/integration-tests.yml

@@ -46,7 +46,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -e ".[dev]"
+          pip install -e ".[dev,mcp]"
       
       - name: Run integration tests
         id: integration_tests

devrev_python_sdk-2.8.1/CLAUDE.md

@@ -0,0 +1,4 @@
+# Claude Rules for py-dev-rev
+
+## Codebase Context
+Always use the codebase-retrieval MCP tool (`mcp__auggie-mcp__codebase-retrieval` or `mcp__auggie__codebase-retrieval`) to get codebase context before beginning any task.

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devrev-Python-SDK
-Version: 2.8.0
+Version: 2.8.1
 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
@@ -18,7 +18,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
+Requires-Dist: beautifulsoup4>=4.12.0
 Requires-Dist: httpx>=0.25.0
+Requires-Dist: markdown>=3.5.0
 Requires-Dist: pydantic-settings>=2.1.0
 Requires-Dist: pydantic>=2.5.0
 Requires-Dist: python-dotenv>=1.0.0
@@ -50,6 +52,7 @@ Provides-Extra: dev
 Requires-Dist: mypy>=1.7.0; extra == 'dev'
 Requires-Dist: pre-commit>=3.6.0; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-benchmark>=4.0.0; extra == 'dev'
 Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
 Requires-Dist: pytest-mock>=3.12.0; extra == 'dev'
 Requires-Dist: pytest<10.0.0,>=7.4.0; extra == 'dev'

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/docs/api/services/articles.md

@@ -20,15 +20,36 @@ Manage knowledge base articles in DevRev.
 
 ```python
 from devrev import DevRevClient
-from devrev.models.articles import ArticlesListRequest
+from devrev.models.articles import ArticlesListRequest, ArticleStatus
 
 client = DevRevClient()
 
+# Simple usage with keyword args
+response = client.articles.list(limit=20)
+for article in response.articles:
+    print(f"{article.title}")
+
+# Filter by status
+response = client.articles.list(status=[ArticleStatus.DRAFT])
+for article in response.articles:
+    print(f"Draft: {article.title}")
+
 # Using a request object
-request = ArticlesListRequest(limit=20)
-articles = client.articles.list(request)
-for article in articles:
+request = ArticlesListRequest(limit=20, status=[ArticleStatus.PUBLISHED])
+response = client.articles.list(request)
+for article in response.articles:
     print(f"{article.title}")
+
+# Paginate through all results using next_cursor
+cursor = None
+all_articles = []
+while True:
+    response = client.articles.list(cursor=cursor, limit=100)
+    all_articles.extend(response.articles)
+    cursor = response.next_cursor
+    if not cursor:
+        break
+print(f"Total articles: {len(all_articles)}")
 ```
 
 ### Get Article

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/docs/changelog.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.8.1] - 2026-03-06
+
+### Fixed
+
+- **CI/CD** — Installed the `mcp` extra in the integration workflow so MCP dependencies are available during integration runs.
+- **Articles integration test** — Updated the articles integration test to match the current response shape.
+
+## [2.8.0] - 2026-03-01
+
 ### Added
 
 - **Unified Article Management** (#161) — Simplified article and artifact workflows:

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "devrev-Python-SDK"
-version = "2.8.0"
+version = "2.8.1"
 description = "A modern, type-safe Python SDK for the DevRev API"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -29,13 +29,16 @@ dependencies = [
     "pydantic-settings>=2.1.0",
     "httpx>=0.25.0",
     "python-dotenv>=1.0.0",
+    "beautifulsoup4>=4.12.0",
+    "markdown>=3.5.0",
 ]
 
 [project.optional-dependencies]
 dev = [
     "pytest>=7.4.0,<10.0.0",
-    "pytest-cov>=4.1.0",
     "pytest-asyncio>=0.21.0",
+    "pytest-benchmark>=4.0.0",
+    "pytest-cov>=4.1.0",
     "pytest-mock>=3.12.0",
     "ruff>=0.1.0",
     "mypy>=1.7.0",

devrev_python_sdk-2.8.1/src/devrev/models/articles.py

@@ -0,0 +1,341 @@
+"""Article models for DevRev SDK."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import StrEnum
+from typing import Any
+
+from pydantic import Field
+
+from devrev.models.base import (
+    CustomSchemaSpec,
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    SetTagWithValue,
+    UserSummary,
+)
+
+
+class ArticleStatus(StrEnum):
+    """Article status enumeration."""
+
+    DRAFT = "draft"
+    PUBLISHED = "published"
+    ARCHIVED = "archived"
+    REVIEW_NEEDED = "review_needed"
+
+
+class ArticleAccessLevel(StrEnum):
+    """Article access level enumeration."""
+
+    EXTERNAL = "external"
+    INTERNAL = "internal"
+    PRIVATE = "private"
+    PUBLIC = "public"
+    RESTRICTED = "restricted"
+
+
+class ArticleType(StrEnum):
+    """Article type enumeration."""
+
+    ARTICLE = "article"
+    CONTENT_BLOCK = "content_block"
+    PAGE = "page"
+
+
+class ArticleContentFormat(StrEnum):
+    """Article content format enumeration."""
+
+    DRDFV2 = "drdfv2"
+    RT = "rt"
+
+
+class CursorMode(StrEnum):
+    """Cursor pagination direction."""
+
+    AFTER = "after"
+    BEFORE = "before"
+
+
+class ArticleScope(DevRevResponseModel):
+    """Scope/visibility level of an article.
+
+    Values observed from the API:
+    - ``{"id": 1, "label": "internal", "ordinal": 1}``
+    - ``{"id": 2, "label": "external", "ordinal": 2}``
+    """
+
+    id: int = Field(..., description="Scope numeric ID (1=internal, 2=external)")
+    label: str | None = Field(default=None, description="Human-readable label")
+    ordinal: int | None = Field(default=None, description="Sort ordinal")
+
+
+class ArticleTagSummary(DevRevResponseModel):
+    """Tag summary as returned within an article's ``tags`` array."""
+
+    id: str = Field(..., description="Tag DON ID")
+    name: str | None = Field(default=None, description="Tag name")
+    display_id: str | None = Field(default=None, description="Tag display ID")
+
+
+class ArticleTagWithValue(DevRevResponseModel):
+    """Tag entry on an article, wrapping the tag summary with an optional value."""
+
+    tag: ArticleTagSummary = Field(..., description="Tag details")
+    value: str | None = Field(default=None, description="Optional tag value")
+
+
+class ArticleParentSummary(DevRevResponseModel):
+    """Summary of a parent directory (collection) for an article."""
+
+    id: str = Field(..., description="Directory DON ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+
+
+class Article(DevRevResponseModel):
+    """DevRev Article model.
+
+    Note: The API returns authored_by as an array of UserSummary objects,
+    not a single UserSummary object as documented in the OpenAPI spec.
+    """
+
+    id: str = Field(..., description="Article ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    title: str = Field(..., description="Article title")
+    description: str | None = Field(default=None, description="Article description/body")
+    status: ArticleStatus | None = Field(default=None, description="Article status")
+    article_type: str | None = Field(default=None, description="Article type (article, page, etc.)")
+    authored_by: list[UserSummary] | None = Field(
+        default=None, description="Authors of the article (API returns array, not single object)"
+    )
+    owned_by: list[UserSummary] | None = Field(default=None, description="Owners of the article")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+    resource: dict[str, Any] | None = Field(
+        default=None, description="Resource configuration including artifact references"
+    )
+    applies_to_parts: list[dict[str, Any]] | None = Field(
+        default=None, description="Parts this article applies to"
+    )
+    scope: ArticleScope | None = Field(
+        default=None, description="Visibility scope (internal/external)"
+    )
+    tags: list[ArticleTagWithValue] | None = Field(
+        default=None, description="Tags applied to the article"
+    )
+    parent: ArticleParentSummary | None = Field(
+        default=None, description="Parent directory/collection"
+    )
+    language: str | None = Field(default=None, description="Language code (e.g., 'en')")
+
+
+class ArticleSummary(DevRevResponseModel):
+    """Summary of an Article."""
+
+    id: str = Field(..., description="Article ID")
+    title: str | None = Field(default=None, description="Article title")
+
+
+class ArticleWithContent(DevRevResponseModel):
+    """Article with its content loaded.
+
+    This model combines article metadata with the actual article body content,
+    which is stored separately as an artifact in the DevRev system.
+    """
+
+    article: Article = Field(..., description="Article metadata")
+    content: str = Field(..., description="Article body content")
+    content_format: str = Field(default="text/plain", description="Content MIME type")
+    content_version: str | None = Field(default=None, description="Artifact version")
+
+
+class SetSharedWithMembership(DevRevBaseModel):
+    """Shared-with membership for articles."""
+
+    member: str = Field(..., description="Member ID")
+    role: str | None = Field(default=None, description="Role")
+
+
+class ArticlesCreateRequest(DevRevBaseModel):
+    """Request to create an article.
+
+    Supports associating the article with parts, a parent collection (directory),
+    scope (internal/external), and tags at creation time.
+    """
+
+    title: str = Field(..., description="Article title")
+    description: str | None = Field(default=None, description="Article description/body")
+    status: ArticleStatus | None = Field(default=None, description="Article status")
+    owned_by: list[str] = Field(..., description="List of dev user IDs who own the article")
+    resource: dict[str, Any] = Field(
+        default_factory=dict, description="Resource configuration for the article"
+    )
+    applies_to_parts: list[str] | None = Field(
+        default=None, description="List of part IDs this article applies to"
+    )
+    scope: int | None = Field(default=None, description="Visibility scope: 1=internal, 2=external")
+    tags: list[SetTagWithValue] | None = Field(
+        default=None, description="Tags to apply (list of {'id': 'tag_id', 'value': ...})"
+    )
+    parent: str | None = Field(default=None, description="Parent directory/collection DON ID")
+    article_type: str | None = Field(
+        default=None, description="Article type: 'article' (default), 'page', 'content_block'"
+    )
+
+
+class ArticlesGetRequest(DevRevBaseModel):
+    """Request to get an article by ID."""
+
+    id: str = Field(..., description="Article ID")
+
+
+class ArticlesDeleteRequest(DevRevBaseModel):
+    """Request to delete an article."""
+
+    id: str = Field(..., description="Article ID to delete")
+
+
+class ArticlesListRequestSharedWith(DevRevBaseModel):
+    """Shared-with filter for listing articles."""
+
+    member: str | None = Field(default=None, description="Member ID filter")
+    role: str | None = Field(default=None, description="Role filter")
+
+
+class ArticlesListRequest(DevRevBaseModel):
+    """Request to list articles."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+    applies_to_parts: list[str] | None = Field(default=None, description="Filter by part IDs")
+    article_type: list[ArticleType] | None = Field(
+        default=None, description="Filter by article types"
+    )
+    authored_by: list[str] | None = Field(default=None, description="Filter by author user IDs")
+    brands: list[str] | None = Field(default=None, description="Filter by brand IDs")
+    created_by: list[str] | None = Field(default=None, description="Filter by creator user IDs")
+    mode: CursorMode | None = Field(default=None, description="Cursor pagination direction")
+    modified_by: list[str] | None = Field(default=None, description="Filter by modifier user IDs")
+    owned_by: list[str] | None = Field(default=None, description="Filter by owner user IDs")
+    parent: list[str] | None = Field(default=None, description="Filter by parent article IDs")
+    scope: list[int] | None = Field(default=None, description="Filter by scope values")
+    shared_with: ArticlesListRequestSharedWith | None = Field(
+        default=None, description="Filter by shared-with membership"
+    )
+    status: list[ArticleStatus] | None = Field(default=None, description="Filter by article status")
+    tags: list[str] | None = Field(default=None, description="Filter by tag IDs")
+
+
+class ArticlesUpdateRequestOwnedBy(DevRevBaseModel):
+    """Owned-by update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set owner IDs")
+
+
+class ArticlesUpdateRequestAuthoredBy(DevRevBaseModel):
+    """Authored-by update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set author IDs")
+
+
+class ArticlesUpdateRequestAliases(DevRevBaseModel):
+    """Aliases update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set aliases")
+
+
+class ArticlesUpdateRequestAppliesToParts(DevRevBaseModel):
+    """Applies-to-parts update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set part IDs")
+
+
+class ArticlesUpdateRequestTags(DevRevBaseModel):
+    """Tags update for articles."""
+
+    set: list[SetTagWithValue] | None = Field(default=None, description="Set tags")
+
+
+class ArticlesUpdateRequest(DevRevBaseModel):
+    """Request to update an article."""
+
+    id: str = Field(..., description="Article ID")
+    title: str | None = Field(default=None, description="New title")
+    description: str | None = Field(default=None, description="New description/body")
+    status: ArticleStatus | None = Field(default=None, description="New status")
+    access_level: ArticleAccessLevel | None = Field(default=None, description="New access level")
+    aliases: ArticlesUpdateRequestAliases | None = Field(default=None, description="New aliases")
+    applies_to_parts: ArticlesUpdateRequestAppliesToParts | None = Field(
+        default=None, description="New applies-to-parts"
+    )
+    authored_by: ArticlesUpdateRequestAuthoredBy | None = Field(
+        default=None, description="New authored-by"
+    )
+    brand: str | None = Field(default=None, description="New brand ID")
+    content_format: ArticleContentFormat | None = Field(
+        default=None, description="New content format"
+    )
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    custom_schema_spec: CustomSchemaSpec | None = Field(
+        default=None, description="Custom schema spec"
+    )
+    language: str | None = Field(default=None, description="New language code")
+    notify: bool | None = Field(default=None, description="Send notifications")
+    owned_by: ArticlesUpdateRequestOwnedBy | None = Field(default=None, description="New owned-by")
+    parent: str | None = Field(default=None, description="New parent article ID")
+    published_version: str | None = Field(default=None, description="Published version")
+    release_notes: str | None = Field(default=None, description="New release notes")
+    artifacts: dict[str, Any] | None = Field(
+        default=None,
+        description="Artifacts update using set wrapper, e.g. {'set': ['artifact_id']}",
+    )
+    resource: dict[str, Any] | None = Field(
+        default=None,
+        description="Resource configuration (read-only on updates, use artifacts instead)",
+    )
+    tags: ArticlesUpdateRequestTags | None = Field(default=None, description="New tags")
+    url: str | None = Field(default=None, description="Article URL")
+
+
+class ArticlesCreateResponse(DevRevResponseModel):
+    """Response from creating an article."""
+
+    article: Article = Field(..., description="Created article")
+
+
+class ArticlesGetResponse(DevRevResponseModel):
+    """Response from getting an article."""
+
+    article: Article = Field(..., description="Retrieved article")
+
+
+class ArticlesListResponse(PaginatedResponse):
+    """Response from listing articles."""
+
+    articles: list[Article] = Field(..., description="List of articles")
+
+
+class ArticlesUpdateResponse(DevRevResponseModel):
+    """Response from updating an article."""
+
+    article: Article = Field(..., description="Updated article")
+
+
+class ArticlesDeleteResponse(DevRevResponseModel):
+    """Response from deleting an article."""
+
+    pass
+
+
+class ArticlesCountRequest(DevRevBaseModel):
+    """Request to count articles (beta only)."""
+
+    status: list[str] | None = Field(default=None, description="Filter by article status")
+
+
+class ArticlesCountResponse(DevRevResponseModel):
+    """Response from counting articles (beta only)."""
+
+    count: int = Field(..., description="Count of matching articles")

{devrev_python_sdk-2.8.0 → devrev_python_sdk-2.8.1}/src/devrev/models/artifacts.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from datetime import datetime
+from typing import Any
 
 from pydantic import Field
 
@@ -13,7 +14,10 @@ class Artifact(DevRevResponseModel):
     """DevRev Artifact model."""
 
     id: str = Field(..., description="Artifact ID")
-    created_by: str | None = Field(default=None, description="Creator user ID")
+    created_by: dict[str, Any] | str | None = Field(
+        default=None,
+        description="Creator - may be a user ID string or a user object dict",
+    )
     created_date: datetime | None = Field(default=None, description="Creation timestamp")
     file_name: str | None = Field(default=None, description="Original file name")
     file_type: str | None = Field(default=None, description="MIME type of the file")
@@ -72,9 +76,7 @@ class ArtifactGetResponse(DevRevResponseModel):
 class ArtifactListRequest(DevRevBaseModel):
     """Request to list artifacts."""
 
-    parent_id: str | None = Field(
-        default=None, description="Filter artifacts by parent object ID"
-    )
+    parent_id: str | None = Field(default=None, description="Filter artifacts by parent object ID")
 
 
 class ArtifactListResponse(PaginatedResponse):