projectdavid-common 0.1.16__tar.gz

projectdavid_common-0.1.16/MANIFEST.in

@@ -0,0 +1 @@
+include README.md

projectdavid_common-0.1.16/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: projectdavid_common
+Version: 0.1.16
+Summary: Common shared custom packages
+Author-email: "Francis N." <francis.neequaye@projectdavid.co.uk>
+License: MIT
+Project-URL: Homepage, https://github.com/frankie336/projectdavid_common
+Keywords: shared,internal,utilities,schemas
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic
+Requires-Dist: typing_extensions
+Requires-Dist: fastapi>=0.70.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+
+# Entities Common
+[![Test, Tag, Publish Status](https://github.com/frankie336/entities_common/actions/workflows/test_tag_release.yml/badge.svg)](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml)
+
+The **Projectdavid Common** SDK is a shared library that serves as a central resource for multiple components within the same
+project. It consolidates common functionality across disparate parts of the project, reducing duplication and improving 
+maintainability. By providing a unified interface, Entities Common simplifies interactions with the 
+and future related products.
+
+[Entities API](https://github.com/frankie336/entities_api), the [projectdavid SDK](https://github.com/frankie336/entitites_sdk)  ,
+
+
+# Resources
+
+| Resource                                                | Descrption                         |
+|---------------------------------------------------------|------------------------------------|
+| [ValidationInterface](/docs/validation_interface.md)     | Unified pydentc validation classes |
+| [UtilsInterface](/docs/utils_interface.md)              | Utilites and tools                 |

projectdavid_common-0.1.16/README.md

@@ -0,0 +1,17 @@
+# Entities Common
+[![Test, Tag, Publish Status](https://github.com/frankie336/entities_common/actions/workflows/test_tag_release.yml/badge.svg)](https://github.com/frankie336/entitites_sdk/actions/workflows/test_tag_release.yml)
+
+The **Projectdavid Common** SDK is a shared library that serves as a central resource for multiple components within the same
+project. It consolidates common functionality across disparate parts of the project, reducing duplication and improving 
+maintainability. By providing a unified interface, Entities Common simplifies interactions with the 
+and future related products.
+
+[Entities API](https://github.com/frankie336/entities_api), the [projectdavid SDK](https://github.com/frankie336/entitites_sdk)  ,
+
+
+# Resources
+
+| Resource                                                | Descrption                         |
+|---------------------------------------------------------|------------------------------------|
+| [ValidationInterface](/docs/validation_interface.md)     | Unified pydentc validation classes |
+| [UtilsInterface](/docs/utils_interface.md)              | Utilites and tools                 |

projectdavid_common-0.1.16/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "projectdavid_common"
+version = "0.1.16"
+description = "Common shared custom packages"
+readme = "README.md"
+authors = [
+  { name = "Francis N.", email = "francis.neequaye@projectdavid.co.uk" }
+]
+license = { text = "MIT" }
+keywords = ["shared", "internal", "utilities", "schemas"]
+requires-python = ">=3.10"
+
+dependencies = [
+  "pydantic",
+  "typing_extensions",
+  "fastapi>=0.70.0"  # Added FastAPI as a dependency
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest"
+]
+
+[project.urls]
+Homepage = "https://github.com/frankie336/projectdavid_common"
+
+[project.scripts]
+projectdavid_common-api = "projectdavid_common.main:main"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["projectdavid_common", "projectdavid_common.*"]
+
+[tool.setuptools.dynamic]
+version = { attr = "projectdavid_common.__version__.__version__" }
+
+[tool.black]
+line-length = 100
+target-version = ["py310"]
+skip-string-normalization = true
+
+[tool.flake8]
+max-line-length = 200
+extend-ignore = ["E203"]
+exclude = [".venv", ".git", "__pycache__", "build", "dist"]
+
+[tool.isort]
+profile = "black"

projectdavid_common-0.1.16/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

projectdavid_common-0.1.16/src/projectdavid_common/__init__.py

@@ -0,0 +1,7 @@
+from .utils import UtilsInterface
+from .validation import ValidationInterface
+
+__all__ = [
+    "ValidationInterface",
+    "UtilsInterface",
+]

projectdavid_common-0.1.16/src/projectdavid_common/constants/platform.py

@@ -0,0 +1,68 @@
+from dotenv import load_dotenv
+
+load_dotenv()
+
+PLATFORM_TOOLS = [
+    "code_interpreter",
+    "web_search",
+    "vector_store_search",
+    "computer",
+]
+
+TOOLS_ID_MAP = {
+    "code_interpreter": "tool_79YkQEz5cDwpJjnR7oJ80D",
+    "web_search": "tool_BiIwycpLo1n5Dh6BHN01v8",
+    "vector_store_search": "tool_MCaJpXJU3eW6vaMUybEf6i",
+    "computer": "tool_PJQ6VcnkmRCMankObjtRcn",
+}
+
+SPECIAL_CASE_TOOL_HANDLING = ["computer", "code_interpreter"]
+
+ERROR_NO_CONTENT = (
+    "ERROR: The Tool has failed to return any content. The current stage of "
+    "the workflow is tool submission. Please inform the user."
+)
+
+DIRECT_DATABASE_URL = "mysql+pymysql://ollama:3e4Qv5uo2Cg31zC1@localhost:3307/cosmic_catalyst"
+
+# ------------------------------------------------
+# Vendors sometimes have clashing model names.
+# This can interfere with routing logic
+# ------------------------------------------------
+MODEL_MAP = {
+    "deepseek-ai/deepseek-reasoner": "deepseek-reasoner",
+    "deepseek-ai/deepseek-chat": "deepseek-chat",
+    "together-ai/deepseek-ai/DeepSeek-R1": "deepseek-ai/DeepSeek-R1",
+    "together-ai/deepseek-ai/DeepSeek-V3": "deepseek-ai/DeepSeek-V3",
+    "hyperbolic/deepseek-ai/DeepSeek-R1": "deepseek-ai/DeepSeek-R1",
+    "hyperbolic/deepseek-ai/DeepSeek-V3": "deepseek-ai/DeepSeek-V3",
+}
+
+WEB_SEARCH_BASE_URL = "http://localhost:8080/"
+
+SUPPORTED_MIME_TYPES = {
+    ".c": "text/x-c",
+    ".cpp": "text/x-c++",
+    ".cs": "text/x-csharp",
+    ".css": "text/css",
+    ".doc": "application/msword",
+    ".docx": ("application/vnd.openxmlformats-officedocument.wordprocessingml." "document"),
+    ".go": "text/x-golang",
+    ".html": "text/html",
+    ".java": "text/x-java",
+    ".js": "text/javascript",
+    ".json": "application/json",
+    ".md": "text/markdown",
+    ".pdf": "application/pdf",
+    ".php": "text/x-php",
+    ".pptx": ("application/vnd.openxmlformats-officedocument.presentationml." "presentation"),
+    ".py": "text/x-python",
+    ".pyx": "text/x-script.python",
+    ".rb": "text/x-ruby",
+    ".sh": "application/x-sh",
+    ".tex": "text/x-tex",
+    ".ts": "application/typescript",
+    ".txt": "text/plain",
+}
+
+ALLOWED_TEXT_ENCODINGS = ["utf-8", "utf-16", "ascii"]

projectdavid_common-0.1.16/src/projectdavid_common/schemas/actions.py

@@ -0,0 +1,103 @@
+# src/projectdavid_common/schemas/actions.py
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+
+class ActionBase(BaseModel):
+    id: str
+    run_id: str
+    triggered_at: datetime
+    expires_at: Optional[datetime] = None
+    is_processed: bool
+    processed_at: Optional[datetime] = None
+    status: str = "pending"
+    function_args: Optional[Dict[str, Any]] = None
+    result: Optional[Dict[str, Any]] = None
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class ActionStatus(str, Enum):
+    pending = "pending"
+    processing = "processing"
+    completed = "completed"
+    failed = "failed"
+    expired = "expired"
+    cancelled = "cancelled"
+    retrying = "retrying"
+
+
+class ActionCreate(BaseModel):
+    id: Optional[str] = None
+    tool_name: Optional[str] = None
+    run_id: str
+    function_args: Optional[Dict[str, Any]] = {}
+    expires_at: Optional[datetime] = None
+    status: Optional[str] = "pending"
+
+    @field_validator("tool_name", mode="before")
+    @classmethod
+    def validate_tool_fields(cls, v: Optional[str]) -> Optional[str]:
+        if not v:
+            raise ValueError("Tool name must be provided.")
+        return v
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "tool_name": "example_tool_name",
+                "run_id": "example_run_id",
+                "function_args": {"arg1": "value1", "arg2": "value2"},
+                "expires_at": "2024-09-10T12:00:00Z",
+                "status": "pending",
+            }
+        }
+    )
+
+
+class ActionRead(BaseModel):
+    id: str = Field(...)
+    run_id: Optional[str] = None
+    tool_id: Optional[str] = None
+    tool_name: Optional[str] = None
+    triggered_at: Optional[str] = None
+    expires_at: Optional[str] = None
+    is_processed: Optional[bool] = None
+    processed_at: Optional[str] = None
+    status: Optional[str] = None
+    function_args: Optional[dict] = None
+    result: Optional[dict] = None
+
+    model_config = ConfigDict(
+        extra="forbid",
+        validate_assignment=True,
+        json_schema_extra={
+            "example": {
+                "id": "action_123456",
+                "run_id": "run_123456",
+                "tool_id": "tool_123456",
+                "tool_name": "code_interpreter",
+                "triggered_at": "2025-03-24T12:00:00Z",
+                "expires_at": "2025-03-24T12:05:00Z",
+                "is_processed": False,
+                "processed_at": "2025-03-24T12:01:00Z",
+                "status": "in_progress",
+                "function_args": {"param1": "value1"},
+                "result": {"output": "result data"},
+            }
+        },
+    )
+
+
+class ActionList(BaseModel):
+    actions: List[ActionRead]
+
+
+class ActionUpdate(BaseModel):
+    status: ActionStatus
+    result: Optional[Dict[str, Any]] = None
+
+    model_config = ConfigDict(from_attributes=True)

projectdavid_common-0.1.16/src/projectdavid_common/schemas/assistants.py

@@ -0,0 +1,102 @@
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from projectdavid_common.schemas.vectors import VectorStoreRead
+
+
+class AssistantCreate(BaseModel):
+    id: Optional[str] = Field(
+        None,
+        description="Unique identifier for the assistant. Optional on creation.",
+    )
+    name: str = Field(..., description="Name of the assistant")
+    description: str = Field("", description="A brief description of the assistant")
+    model: str = Field(..., description="Model used by the assistant")
+    instructions: str = Field(
+        "", description="Special instructions or guidelines for the assistant"
+    )
+    tools: Optional[List[dict]] = Field(
+        None,
+        description="A list of tools available to the assistant, each defined as a dictionary",
+    )
+    meta_data: Optional[dict] = Field(None, description="Additional metadata for the assistant")
+    top_p: float = Field(1.0, description="Top-p sampling parameter for text generation")
+    temperature: float = Field(1.0, description="Temperature parameter for text generation")
+    response_format: str = Field("auto", description="Format of the assistant's response")
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "name": "ChatGPT Assistant",
+                "description": "An assistant for handling tasks",
+                "model": "gpt-4",
+                "instructions": "Be friendly and concise",
+                "tools": [{"name": "code_interpreter"}],
+                "meta_data": {"project": "alpha"},
+                "top_p": 0.9,
+                "temperature": 0.8,
+                "response_format": "auto",
+            }
+        }
+    )
+
+
+class AssistantRead(BaseModel):
+    id: str = Field(..., description="Unique identifier for the assistant")
+    user_id: Optional[str] = Field(
+        None, description="Identifier for the user associated with " "the assistant"
+    )
+    object: str = Field(..., description="Object type")
+    created_at: int = Field(..., description="Timestamp when the assistant was created")
+    name: str = Field(..., description="Name of the assistant")
+    description: Optional[str] = Field(None, description="Description of the assistant")
+    model: str = Field(..., description="Model used by the assistant")
+    instructions: Optional[str] = Field(None, description="Instructions provided to the assistant")
+    tools: Optional[List[dict]] = Field(
+        None, description="List of tool definitions associated " "with " "the assistant"
+    )
+    meta_data: Optional[Dict[str, Any]] = Field(
+        None, description="Additional metadata for " "the assistant"
+    )
+    top_p: float = Field(..., description="Top-p sampling parameter")
+    temperature: float = Field(..., description="Temperature parameter")
+    response_format: str = Field(..., description="Response format")
+    vector_stores: Optional[List[VectorStoreRead]] = Field(
+        default_factory=list, description="List of associated vector stores"
+    )
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "id": "asst_abc123",
+                "user_id": "user_xyz",
+                "object": "assistant",
+                "created_at": 1710000000,
+                "name": "Doc Searcher",
+                "description": "Assistant for searching documents",
+                "model": "gpt-4",
+                "instructions": "Answer based on vector store contents",
+                "tools": [{"name": "vector_store_search"}],
+                "meta_data": {"department": "research"},
+                "top_p": 1.0,
+                "temperature": 0.7,
+                "response_format": "auto",
+                "vector_stores": [],
+            }
+        }
+    )
+
+
+class AssistantUpdate(BaseModel):
+    name: Optional[str] = Field(None, description="Updated name for the assistant")
+    description: Optional[str] = Field(None, description="Updated description for the assistant")
+    model: Optional[str] = Field(None, description="Updated model name")
+    instructions: Optional[str] = Field(None, description="Updated instructions for the assistant")
+    tools: Optional[List[Any]] = Field(None, description="Updated list of tools for the assistant")
+    meta_data: Optional[Dict[str, Any]] = Field(
+        None, description="Updated metadata for the " "assistant"
+    )
+    top_p: Optional[float] = Field(None, description="Updated top-p parameter")
+    temperature: Optional[float] = Field(None, description="Updated temperature parameter")
+    response_format: Optional[str] = Field(None, description="Updated response format")

projectdavid_common-0.1.16/src/projectdavid_common/schemas/enums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class ProviderEnum(str, Enum):
+    openai = "openai"
+    deepseek = "deepseek"
+    hyperbolic = "Hyperbolic"
+    togetherai = "togetherai"
+    local = "local"
+
+
+class StatusEnum(str, Enum):
+    deleted = "deleted"
+    active = "active"
+    queued = "queued"
+    in_progress = "in_progress"
+    pending_action = "action_required"
+    completed = "completed"
+    failed = "failed"
+    cancelling = "cancelling"
+    cancelled = "cancelled"
+    pending = "pending"
+    processing = "processing"
+    expired = "expired"
+    retrying = "retrying"

projectdavid_common-0.1.16/src/projectdavid_common/schemas/file_service.py

@@ -0,0 +1,21 @@
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class FileUploadRequest(BaseModel):
+    purpose: str = Field(..., description="Purpose for uploading the file")
+    user_id: str = Field(..., description="ID of the uploading user")
+
+
+class FileResponse(BaseModel):
+    id: str
+    object: str = "file"
+    bytes: int
+    created_at: int
+    filename: str
+    purpose: str
+    status: str = "uploaded"
+    expires_at: Optional[int] = None
+
+    model_config = ConfigDict(from_attributes=True)

projectdavid_common-0.1.16/src/projectdavid_common/schemas/files.py

@@ -0,0 +1,34 @@
+from datetime import datetime
+from typing import Optional
+
+from fastapi import Form
+from pydantic import BaseModel, ConfigDict, field_validator
+
+
+class FileUploadRequest(BaseModel):
+    """Schema for file upload request data."""
+
+    purpose: str = Form(...)
+    user_id: str = Form(...)
+
+
+class FileResponse(BaseModel):
+    """Schema for file response data."""
+
+    id: str
+    object: str = "file"
+    bytes: int
+    created_at: int
+    filename: str
+    purpose: str
+    status: str = "uploaded"
+    expires_at: Optional[int] = None
+
+    @field_validator("created_at", mode="before")
+    @classmethod
+    def datetime_to_timestamp(cls, value):
+        if isinstance(value, datetime):
+            return int(value.timestamp())
+        return value
+
+    model_config = ConfigDict(from_attributes=True)

projectdavid_common-0.1.16/src/projectdavid_common/schemas/inference.py

@@ -0,0 +1,25 @@
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from projectdavid_common.schemas.enums import ProviderEnum
+
+
+class ProcessOutput(BaseModel):
+    store_name: str
+    status: str
+    chunks_processed: int
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class StreamRequest(BaseModel):
+    provider: ProviderEnum = Field(..., description="The inference provider")
+    model: str = Field(..., description="The model to use for inference")
+    api_key: Optional[str] = Field(None, description="Optional API key for third-party providers")
+    thread_id: str = Field(..., description="Thread identifier")
+    message_id: str = Field(..., description="Message identifier")
+    run_id: str = Field(..., description="Run identifier")
+    assistant_id: str = Field(..., description="Assistant identifier")
+
+    model_config = ConfigDict(from_attributes=True)

projectdavid_common-0.1.16/src/projectdavid_common/schemas/keys.py

@@ -0,0 +1,23 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class APIKeyRead(BaseModel):
+    id: str = Field(..., description="The unique identifier for this API key")
+    user_id: str = Field(..., description="User who owns the key")
+    name: str = Field(..., description="Human-readable name of the key")
+    created_at: int = Field(..., description="Unix timestamp of key creation")
+    revoked: bool = Field(..., description="Whether the key has been revoked")
+    revoked_at: Optional[int] = Field(None, description="Unix timestamp of revocation (if revoked)")
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class APIKeyCreate(BaseModel):
+    user_id: str = Field(..., description="ID of the user creating the key")
+    name: Optional[str] = Field(None, description="Optional human-readable name for the key")
+    expires_at: Optional[datetime] = Field(
+        None, description="Optional expiration date for the API key"
+    )

projectdavid_common-0.1.16/src/projectdavid_common/schemas/messages.py

@@ -0,0 +1,95 @@
+#! python
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict, field_validator
+
+
+class MessageRole(str, Enum):
+    PLATFORM = "platform"
+    ASSISTANT = "assistant"
+    USER = "user"
+    SYSTEM = "system"
+    TOOL = "tool"
+
+
+class MessageCreate(BaseModel):
+    content: str
+    thread_id: str
+    sender_id: Optional[str] = None
+    assistant_id: str
+    role: str  # Using string instead of Enum to allow flexible validation
+    tool_id: Optional[str] = None
+    meta_data: Optional[Dict[str, Any]] = None
+    is_last_chunk: bool = False
+
+    @field_validator("role", mode="before")
+    @classmethod
+    def validate_role(cls, v):
+        valid_roles = {"platform", "assistant", "user", "system", "tool"}
+        if isinstance(v, str):
+            v = v.lower()
+            if v in valid_roles:
+                return v
+        raise ValueError(f"Invalid role: {v}. Must be one of {list(valid_roles)}")
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "content": "Hello, this is a test message.",
+                "thread_id": "example_thread_id",
+                "assistant_id": "example_assistant_id",
+                "meta_data": {"key": "value"},
+                "role": "user",
+            }
+        }
+    )
+
+
+class ToolMessageCreate(BaseModel):
+    content: str
+
+    model_config = ConfigDict(
+        json_schema_extra={"example": {"content": "This is the content of the tool message."}}
+    )
+
+
+class MessageRead(BaseModel):
+    id: str
+    assistant_id: Optional[str]
+    attachments: List[Any]
+    completed_at: Optional[int]
+    content: str
+    created_at: int
+    incomplete_at: Optional[int]
+    incomplete_details: Optional[Dict[str, Any]]
+    meta_data: Dict[str, Any]
+    object: str
+    role: str
+    run_id: Optional[str]
+    tool_id: Optional[str] = None
+    status: Optional[str]
+    thread_id: str
+    sender_id: Optional[str] = None
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class MessageUpdate(BaseModel):
+    content: Optional[str]
+    meta_data: Optional[Dict[str, Any]]
+    status: Optional[str]
+    role: Optional[str]
+
+    @field_validator("role", mode="before")
+    @classmethod
+    def validate_role(cls, v):
+        if v is None:
+            return v
+        valid_roles = {"platform", "assistant", "user", "system", "tool"}
+        v = v.lower()
+        if v in valid_roles:
+            return v
+        raise ValueError(f"Invalid role: {v}. Must be one of {list(valid_roles)}")
+
+    model_config = ConfigDict(from_attributes=True)