vaiz-sdk 0.1.0__py3-none-any.whl

vaiz/__init__.py

@@ -0,0 +1,21 @@
+from .client import VaizClient
+from .models import (
+    TaskFollower,
+    TaskPriority,
+    CustomField,
+    CreateTaskRequest,
+    EditTaskRequest,
+    Task,
+    TaskResponse,
+)
+
+__all__ = [
+    'VaizClient',
+    'TaskFollower',
+    'TaskPriority',
+    'CustomField',
+    'CreateTaskRequest',
+    'EditTaskRequest',
+    'Task',
+    'TaskResponse',
+]

vaiz/api/__init__.py

@@ -0,0 +1,4 @@
+from vaiz.api.base import BaseAPIClient
+from vaiz.api.tasks import TasksAPIClient
+
+__all__ = ['BaseAPIClient', 'TasksAPIClient'] 

vaiz/api/base.py

@@ -0,0 +1,27 @@
+import requests
+from typing import Dict, Any
+
+class BaseAPIClient:
+    def __init__(self, api_key: str, space_id: str, base_url: str = "https://api.vaiz.com/v4", verify_ssl: bool = True):
+        self.api_key = api_key
+        self.space_id = space_id
+        self.base_url = base_url
+        self.verify_ssl = verify_ssl
+        self.session = requests.Session()
+        self.session.headers.update({
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+            "current-space-id": self.space_id,
+            "app-version": "1.68.1",
+        })
+
+    def _make_request(self, endpoint: str, method: str = "POST", json_data: Dict[str, Any] = None) -> Dict[str, Any]:
+        url = f"{self.base_url}/{endpoint}"
+        print(f"Request payload: {json_data}")  # Debug print
+        response = self.session.request(method, url, json=json_data, verify=self.verify_ssl)
+        if not response.ok:
+            print(f"Error response: {response.text}")  # Debug print
+        response.raise_for_status()
+        response_data = response.json()
+        print(f"Response data: {response_data}")  # Debug print
+        return response_data 

vaiz/api/boards.py

@@ -0,0 +1,27 @@
+from vaiz.api.base import BaseAPIClient
+from vaiz.models import BoardsResponse, BoardResponse
+
+
+class BoardsAPIClient(BaseAPIClient):
+    def get_boards(self) -> BoardsResponse:
+        """
+        Get all boards in the current space.
+        
+        Returns:
+            BoardsResponse: The list of boards
+        """
+        response_data = self._make_request("getBoards", method="POST", json_data={})
+        return BoardsResponse(**response_data)
+
+    def get_board(self, board_id: str) -> BoardResponse:
+        """
+        Get a single board by its ID.
+        
+        Args:
+            board_id (str): The ID of the board to retrieve
+            
+        Returns:
+            BoardResponse: The board information
+        """
+        response_data = self._make_request("getBoard", method="POST", json_data={"boardId": board_id})
+        return BoardResponse(**response_data) 

vaiz/api/profile.py

@@ -0,0 +1,14 @@
+from vaiz.api.base import BaseAPIClient
+from vaiz.models import ProfileResponse
+
+
+class ProfileAPIClient(BaseAPIClient):
+    def get_profile(self) -> ProfileResponse:
+        """
+        Get the current user's profile.
+        
+        Returns:
+            ProfileResponse: The user's profile information
+        """
+        response_data = self._make_request("getProfile", method="POST", json_data={})
+        return ProfileResponse(**response_data) 

vaiz/api/tasks.py

@@ -0,0 +1,43 @@
+from vaiz.api.base import BaseAPIClient
+from vaiz.models import CreateTaskRequest, TaskResponse, EditTaskRequest
+
+
+class TasksAPIClient(BaseAPIClient):
+    def create_task(self, task: CreateTaskRequest) -> TaskResponse:
+        """
+        Create a new task.
+        
+        Args:
+            task (CreateTaskRequest): The task creation request containing all necessary task information
+            
+        Returns:
+            TaskResponse: The created task information
+        """
+        response_data = self._make_request("createTask", json_data=task.model_dump(by_alias=True))
+        return TaskResponse(**response_data)
+
+    def edit_task(self, task: EditTaskRequest) -> TaskResponse:
+        """
+        Edit an existing task.
+        
+        Args:
+            task (EditTaskRequest): The task edit request containing the updated task information
+            
+        Returns:
+            TaskResponse: The updated task information
+        """
+        response_data = self._make_request("editTask", json_data=task.model_dump(by_alias=True))
+        return TaskResponse(**response_data)
+
+    def get_task(self, slug: str) -> TaskResponse:
+        """
+        Get task information by its slug.
+        
+        Args:
+            slug (str): The task slug (e.g. "ABC-123")
+            
+        Returns:
+            TaskResponse: The task information
+        """
+        response_data = self._make_request("getTask", json_data={"slug": slug})
+        return TaskResponse(**response_data) 

vaiz/client.py

@@ -0,0 +1,14 @@
+# vaiz/client.py
+from vaiz.api.tasks import TasksAPIClient
+from vaiz.api.boards import BoardsAPIClient
+from vaiz.api.profile import ProfileAPIClient
+
+
+class VaizClient(TasksAPIClient, BoardsAPIClient, ProfileAPIClient):
+    """
+    Main client for interacting with the Vaiz API.
+    This class inherits all task-related operations from TasksAPIClient,
+    board-related operations from BoardsAPIClient,
+    and profile-related operations from ProfileAPIClient.
+    """
+    pass

vaiz/models/__init__.py

@@ -0,0 +1,19 @@
+from .base import TaskFollower, TaskPriority, CustomField
+from .tasks import Task, TaskResponse, CreateTaskRequest, EditTaskRequest
+from vaiz.models.boards import Board, BoardsResponse, BoardResponse
+from vaiz.models.profile import Profile, ProfileResponse
+
+__all__ = [
+    'TaskFollower',
+    'TaskPriority',
+    'CustomField',
+    'CreateTaskRequest',
+    'EditTaskRequest',
+    'Task',
+    'TaskResponse',
+    'Board',
+    'BoardsResponse',
+    'BoardResponse',
+    'Profile',
+    'ProfileResponse'
+] 

vaiz/models/base.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, RootModel, Field
+from typing import List, Optional, Dict, Literal, Any, Union
+from enum import Enum
+
+
+class TaskFollower(RootModel):
+    root: Dict[str, Literal["creator"]]
+
+
+class TaskPriority(int, Enum):
+    Low = 0
+    General = 1
+    Medium = 2
+    High = 3
+
+
+class CustomField(BaseModel):
+    id: str
+    value: Union[str, List[str]] 

vaiz/models/boards.py

@@ -0,0 +1,55 @@
+from typing import List, Optional, Dict, Any
+from pydantic import BaseModel, Field
+
+
+class BoardGroup(BaseModel):
+    name: str
+    id: str = Field(..., alias="_id")
+
+
+class BoardType(BaseModel):
+    label: str
+    icon: str
+    color: str
+    id: str = Field(..., alias="_id")
+    description: Optional[str] = None
+
+
+class BoardCustomField(BaseModel):
+    name: str
+    type: str
+    id: str = Field(..., alias="_id")
+    description: Optional[str] = None
+    options: Optional[List[Any]] = None
+    hidden: Optional[bool] = None
+
+
+class Board(BaseModel):
+    id: str = Field(..., alias="_id")
+    name: str
+    project: Optional[str] = None
+    creator: Optional[str] = None
+    archiver: Optional[str] = None
+    archived_at: Optional[str] = Field(None, alias="archivedAt")
+    created_at: Optional[str] = Field(None, alias="createdAt")
+    deleter: Optional[str] = None
+    deleted_at: Optional[str] = Field(None, alias="deletedAt")
+    groups: Optional[List[BoardGroup]] = None
+    types_list: Optional[List[BoardType]] = Field(None, alias="typesList")
+    custom_fields: Optional[List[BoardCustomField]] = Field(None, alias="customFields")
+    task_order_by_groups: Optional[Dict[str, List[str]]] = Field(None, alias="taskOrderByGroups")
+    updated_at: Optional[str] = Field(None, alias="updatedAt")
+
+
+class BoardsPayload(BaseModel):
+    boards: List[Board]
+
+
+class BoardsResponse(BaseModel):
+    type: str
+    payload: BoardsPayload
+
+
+class BoardResponse(BaseModel):
+    type: str
+    payload: Dict[str, Board] = Field(..., alias="payload") 

vaiz/models/profile.py

@@ -0,0 +1,36 @@
+from pydantic import BaseModel, Field
+from typing import Optional, List, Dict, Any
+
+
+class ProfileEmail(BaseModel):
+    email: str
+    confirmed: bool
+    primary: bool
+
+
+class ProfileColor(BaseModel):
+    color: Dict[str, Any] = {}
+
+
+class Profile(BaseModel):
+    id: str = Field(..., alias="_id")
+    fullName: str
+    nickName: str
+    email: str
+    emails: List[ProfileEmail]
+    color: ProfileColor = Field(default_factory=ProfileColor)
+    avatarMode: int
+    incompleteSteps: List[str]
+    registeredDate: str
+    recoveryCodes: List[str]
+    passwordChangedDate: str
+    passwordHash: str
+    memberId: str
+    created_at: str = Field(..., alias="createdAt")
+    updated_at: str = Field(..., alias="updatedAt")
+    cData: Dict[str, Optional[str]]
+
+
+class ProfileResponse(BaseModel):
+    type: str
+    payload: Dict[str, Profile] = Field(..., alias="payload") 

vaiz/models/tasks.py

@@ -0,0 +1,94 @@
+from pydantic import BaseModel
+from typing import Dict, Any, List, Optional
+from datetime import datetime
+from .base import TaskPriority, CustomField
+
+
+class TaskCustomField(BaseModel):
+    id: str
+    value: Any
+    _id: str
+
+
+class Task(BaseModel):
+    _id: str
+    name: str
+    group: str
+    board: str
+    project: str
+    parentTask: Optional[str] = None
+    types: List[str] = []
+    priority: int
+    hrid: str
+    followers: Dict[str, str]
+    archiver: Optional[str] = None
+    completed: bool
+    assignees: List[str] = []
+    subtasks: List[str] = []
+    milestones: List[str] = []
+    dueStart: Optional[str] = None
+    dueEnd: Optional[str] = None
+    rightConnectors: List[str] = []
+    leftConnectors: List[str] = []
+    archivedAt: Optional[str] = None
+    completedAt: Optional[str] = None
+    customFields: List[TaskCustomField] = []
+    deleter: Optional[str] = None
+    deletedAt: Optional[str] = None
+    creator: str
+    createdAt: str
+    updatedAt: str
+    document: str
+    editor: Optional[str] = None
+    milestone: Optional[str] = None
+
+
+class TaskResponse(BaseModel):
+    payload: Dict[str, Any]
+    type: str
+
+
+class CreateTaskRequest(BaseModel):
+    name: str
+    group: str
+    board: str
+    project: str
+    parentTask: Optional[str] = None
+    types: List[str] = []
+    priority: TaskPriority = TaskPriority.General
+    completed: bool = False
+    assignees: List[str] = []
+    subtasks: List[str] = []
+    milestones: List[str] = []
+    dueStart: Optional[str] = None
+    dueEnd: Optional[str] = None
+    rightConnectors: List[str] = []
+    leftConnectors: List[str] = []
+    customFields: List[CustomField] = []
+
+    def model_dump(self, **kwargs):
+        # Remove None values from the dict
+        data = super().model_dump(**kwargs)
+        return {k: v for k, v in data.items() if v is not None}
+
+
+class EditTaskRequest(BaseModel):
+    taskId: str
+    name: Optional[str] = None
+    parentTask: Optional[str] = None
+    types: Optional[List[str]] = None
+    priority: Optional[TaskPriority] = None
+    completed: Optional[bool] = None
+    assignees: Optional[List[str]] = None
+    subtasks: Optional[List[str]] = None
+    milestones: Optional[List[str]] = None
+    dueStart: Optional[str] = None
+    dueEnd: Optional[str] = None
+    rightConnectors: Optional[List[str]] = None
+    leftConnectors: Optional[List[str]] = None
+    customFields: Optional[List[CustomField]] = None
+
+    def model_dump(self, **kwargs):
+        # Remove None values from the dict
+        data = super().model_dump(**kwargs)
+        return {k: v for k, v in data.items() if v is not None} 

vaiz_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: vaiz-sdk
+Version: 0.1.0
+Summary: Official SDK for interacting with the Vaiz API
+Author-email: Vaiz <mail@vaiz.com>
+License: MIT
+Project-URL: Homepage, https://github.com/vaizcom/vaiz-python-sdk
+Project-URL: Repository, https://github.com/vaizcom/vaiz-python-sdk
+Project-URL: Issues, https://github.com/vaizcom/vaiz-python-sdk/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dotenv>=0.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
+
+# Vaiz SDK for Python
+
+Python SDK for accessing the Vaiz platform.
+
+## Installation
+
+```bash
+pip install vaiz-sdk
+```
+
+## Usage
+
+### Basic Setup
+
+First, you need to set up your environment variables. Create a `.env` file in your project root with the following variables:
+
+```env
+VAIZ_API_KEY=your_api_key
+VAIZ_SPACE_ID=your_space_id
+```
+
+### Creating a Client
+
+```python
+from vaiz import VaizClient
+
+client = VaizClient(
+    api_key="your_api_key",
+    space_id="your_space_id",
+    verify_ssl=False,  # Set to True in production
+    base_url="https://api.vaiz.local:10000/v4"  # Use appropriate base URL for your environment
+)
+```
+
+### Working with Boards
+
+#### Get All Boards
+
+```python
+response = client.get_boards()
+```
+
+#### Get a Single Board
+
+```python
+response = client.get_board("board_id")
+board = response.payload["board"]
+```
+
+### Working with Profile
+
+#### Get User Profile
+
+```python
+response = client.get_profile()
+profile = response.payload["profile"]
+```
+
+### Working with Tasks
+
+#### Create a Task
+
+```python
+from vaiz.models import CreateTaskRequest, TaskPriority
+
+task = CreateTaskRequest(
+    name="My Task",
+    group="group_id",
+    board="board_id",
+    project="project_id",
+    priority=TaskPriority.High,
+    completed=False,
+    types=["type_id"],
+    subtasks=[],
+    milestones=[],
+    rightConnectors=[],
+    leftConnectors=[]
+)
+
+response = client.create_task(task)
+```
+
+#### Edit a Task
+
+```python
+from vaiz.models import EditTaskRequest
+
+edit_task = EditTaskRequest(
+    taskId="task_id",
+    name="Updated Task Name",
+    assignees=["assignee_id"]
+)
+
+response = client.edit_task(edit_task)
+```
+
+#### Get Task Information
+
+```python
+response = client.get_task("task_id")
+```
+
+## Development
+
+### Setting Up Development Environment
+
+1. Create and activate a virtual environment:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate  # On Windows use: venv\Scripts\activate
+```
+
+2. Install the package in development mode:
+
+```bash
+pip install -e .
+```
+
+### Testing
+
+#### Setup
+
+1. Install test dependencies:
+
+```bash
+pip install pytest pytest-mock python-dotenv
+```
+
+2. Create a `.env` file in the project root with your test credentials:
+
+```env
+VAIZ_API_KEY=your_test_api_key
+VAIZ_SPACE_ID=your_test_space_id
+```
+
+The test configuration (`tests/test_config.py`) will automatically load these credentials.
+
+#### Running Tests
+
+Run all tests:
+
+```bash
+PYTHONPATH=. pytest
+```
+
+Run specific test file:
+
+```bash
+PYTHONPATH=. pytest tests/test_client.py
+```
+
+Run with verbose output:
+
+```bash
+PYTHONPATH=. pytest -v
+```
+
+Note: Setting `PYTHONPATH=.` is required to ensure Python can find the package modules during testing.
+
+#### Writing Tests
+
+When writing tests for the SDK:
+
+1. Use the test configuration from `tests/test_config.py`:
+
+```python
+from tests.test_config import get_test_client, TEST_BOARD_ID, TEST_GROUP_ID
+
+def test_create_task(mocker):
+    client = get_test_client()
+    # Your test code here
+```
+
+2. Mock external API calls using `pytest-mock`:
+
+```python
+def test_create_task(mocker):
+    # Mock the API response
+    mock_response = mocker.Mock()
+    mock_response.json.return_value = {
+        "type": "success",
+        "payload": {"task": {"_id": "test_task_id"}}
+    }
+    mocker.patch('requests.post', return_value=mock_response)
+
+    # Test implementation
+    client = get_test_client()
+    # ... rest of the test
+```
+
+3. Test both success and error cases
+4. Include proper assertions for response data
+
+### Examples
+
+The `examples/` directory contains working examples of SDK usage. You can run any example using the following command:
+
+```bash
+python -m examples.<example_file_name>
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Write tests for your changes
+4. Ensure all tests pass
+5. Submit a pull request
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

vaiz_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+vaiz/__init__.py,sha256=XZoRA0PeDpAE89qTSJhveE_ohddl7cKC3-DuhYlB4Sk,351
+vaiz/client.py,sha256=INb5Ih1zWdMtWm3YFoUa3ktBzwnknfkb8Iif7Cb39NY,477
+vaiz/api/__init__.py,sha256=5ANcTY3JTzEATofnKd8ZE603Ma37Jm09QqbQEzWhjis,129
+vaiz/api/base.py,sha256=0LesFM181BY1sDwihjYJOPN_sXo1y5bUbAAyBAD2k-g,1184
+vaiz/api/boards.py,sha256=hlx2hTNNuPbMvIiypgVCFmxaxp4Zb0926CiBxyAp84o,883
+vaiz/api/profile.py,sha256=YpcoTm9pdvY2F4LNXqPfHuuvWAKY8zjK3UMtxx89jB8,451
+vaiz/api/tasks.py,sha256=rPsJTM2X5joLq6BaMVqM4wjP_96te0AXJdxhT20aZhA,1495
+vaiz/models/__init__.py,sha256=YNG1xUFL_-O7Dv2RX5VABcCX0uW0CivmJ46iVLOvrlQ,504
+vaiz/models/base.py,sha256=S28GHWl_P1Y0H4sM9L-PRkj6lTDhjwH5y77M5pLBx58,371
+vaiz/models/boards.py,sha256=_ryO3nN6fZzp--FEs56C_qN5ybDaRLeZHhk87YiluoY,1549
+vaiz/models/profile.py,sha256=8LkBhAAppf7bSwh14bmoXy2GZpJ424iYkfvLUcnAO6E,868
+vaiz/models/tasks.py,sha256=JeYjtMzKWC2HPBQVV75Jq4tSXBBlU87OGK1-FG54La0,2608
+vaiz_sdk-0.1.0.dist-info/METADATA,sha256=otXxFj2XGsGBt93OYEcbwoY3749RqyTNJ0Q5WuJNgRc,5027
+vaiz_sdk-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+vaiz_sdk-0.1.0.dist-info/top_level.txt,sha256=DpUEygwuEftG1YPnj8f-Zpy_p8IEZdWPCDb2P2-4q5U,5
+vaiz_sdk-0.1.0.dist-info/RECORD,,

vaiz_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

vaiz_sdk-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+vaiz