vaiz-sdk 0.1.0__tar.gz

vaiz_sdk-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,213 @@
+# 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/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "vaiz-sdk"
+version = "0.1.0"
+description = "Official SDK for interacting with the Vaiz API"
+authors = [
+    { name = "Vaiz", email = "mail@vaiz.com" }
+]
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.8"
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "requests>=2.31.0",
+    "pydantic>=2.0",
+    "python-dotenv>=0.9.0"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-mock>=3.12.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/vaizcom/vaiz-python-sdk"
+Repository = "https://github.com/vaizcom/vaiz-python-sdk"
+Issues = "https://github.com/vaizcom/vaiz-python-sdk/issues"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

vaiz_sdk-0.1.0/setup.cfg

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

vaiz_sdk-0.1.0/tests/test_boards.py

@@ -0,0 +1,26 @@
+import pytest
+from vaiz.models import BoardsResponse, Board, BoardResponse
+from tests.test_config import get_test_client, TEST_BOARD_ID
+
+def test_get_boards():
+    client = get_test_client()
+    response = client.get_boards()
+    assert isinstance(response, BoardsResponse)
+    assert hasattr(response.payload, 'boards')
+    boards = response.payload.boards
+    assert isinstance(boards, list)
+    # Проверим хотя бы одну доску, если есть
+    if boards:
+        board = boards[0]
+        assert isinstance(board, Board)
+        assert isinstance(board.id, str)
+        assert isinstance(board.name, str)
+
+def test_get_board():
+    client = get_test_client()
+    response = client.get_board(TEST_BOARD_ID)
+    assert isinstance(response, BoardResponse)
+    assert isinstance(response.payload["board"], Board)
+    board = response.payload["board"]
+    assert board.id == TEST_BOARD_ID
+    assert isinstance(board.name, str) 

vaiz_sdk-0.1.0/tests/test_client.py

@@ -0,0 +1,46 @@
+import pytest
+from tests.test_config import get_test_client, TEST_BOARD_ID, TEST_GROUP_ID, TEST_PROJECT_ID, TEST_ASSIGNEE_ID
+from vaiz.models import CreateTaskRequest, EditTaskRequest, TaskPriority
+
+@pytest.fixture(scope="module")
+def client():
+    return get_test_client()
+
+@pytest.fixture(scope="module")
+def task_id(client):
+    task = CreateTaskRequest(
+        name="Integration Test Task",
+        group=TEST_GROUP_ID,
+        board=TEST_BOARD_ID,
+        project=TEST_PROJECT_ID,
+        priority=TaskPriority.High,
+        completed=False,
+        types=["649bea169d17e4070e0337fa"],
+        assignees=[TEST_ASSIGNEE_ID],
+        subtasks=[],
+        milestones=[],
+        rightConnectors=[],
+        leftConnectors=[]
+    )
+    response = client.create_task(task)
+    assert response.type == "CreateTask"
+    return response.payload["task"]["_id"]
+
+def test_create_task(client, task_id):
+    assert task_id
+
+def test_edit_task(client, task_id):
+    edit_task = EditTaskRequest(
+        taskId=task_id,
+        name="Integration Test Task Updated",
+        assignees=[TEST_ASSIGNEE_ID]
+    )
+    response = client.edit_task(edit_task)
+    assert response.type == "EditTask"
+    assert response.payload["task"]["name"] == "Integration Test Task Updated"
+
+def test_get_task(client, task_id):
+    response = client.get_task(task_id)
+    assert response.type == "GetTask"
+    assert response.payload["task"]["_id"] == task_id
+    assert response.payload["task"]["name"] == "Integration Test Task Updated"

vaiz_sdk-0.1.0/tests/test_config.py

@@ -0,0 +1,35 @@
+"""
+Test configuration module for Vaiz SDK tests.
+Contains test credentials and helper functions for testing.
+"""
+
+import os
+from dotenv import load_dotenv
+from vaiz import VaizClient
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Test credentials
+TEST_API_KEY = os.getenv("VAIZ_API_KEY")
+if not TEST_API_KEY:
+    raise ValueError("Please set VAIZ_API_KEY environment variable or create a .env file with VAIZ_API_KEY=your_api_key")
+
+TEST_SPACE_ID = os.getenv("VAIZ_SPACE_ID")
+if not TEST_SPACE_ID:
+    raise ValueError("Please set VAIZ_SPACE_ID environment variable or create a .env file with VAIZ_SPACE_ID=your_space_id")
+
+# Test configuration constants
+TEST_BOARD_ID = "68455de3e48da05d905c51e1"
+TEST_GROUP_ID = "68455de3e48da05d905c51e2"
+TEST_PROJECT_ID = "676d6758c6ea65cbc1f06d81"
+TEST_ASSIGNEE_ID = "676d6758c6ea65cbc1f06d70"
+
+def get_test_client():
+    """Initialize and return a VaizClient instance for testing."""
+    return VaizClient(
+        api_key=TEST_API_KEY,
+        space_id=TEST_SPACE_ID,
+        verify_ssl=False,
+        base_url="https://api.vaiz.local:10000/v4"
+    ) 

vaiz_sdk-0.1.0/tests/test_profile.py

@@ -0,0 +1,23 @@
+import pytest
+from vaiz.models import ProfileResponse, Profile
+from tests.test_config import get_test_client
+
+
+def test_get_profile():
+    client = get_test_client()
+    response = client.get_profile()
+    assert isinstance(response, ProfileResponse)
+    assert isinstance(response.payload["profile"], Profile)
+    profile = response.payload["profile"]
+    assert isinstance(profile.id, str)
+    assert isinstance(profile.fullName, str)
+    assert isinstance(profile.nickName, str)
+    assert isinstance(profile.email, str)
+    assert isinstance(profile.emails, list)
+    assert len(profile.emails) > 0
+    assert isinstance(profile.emails[0].email, str)
+    assert isinstance(profile.emails[0].confirmed, bool)
+    assert isinstance(profile.emails[0].primary, bool)
+    assert isinstance(profile.avatarMode, int)
+    assert isinstance(profile.incompleteSteps, list)
+    assert isinstance(profile.memberId, str) 

vaiz_sdk-0.1.0/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_sdk-0.1.0/vaiz/api/__init__.py

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

vaiz_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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_sdk-0.1.0/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/vaiz_sdk.egg-info/PKG-INFO

@@ -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/vaiz_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,24 @@
+README.md
+pyproject.toml
+setup.cfg
+tests/test_boards.py
+tests/test_client.py
+tests/test_config.py
+tests/test_profile.py
+vaiz/__init__.py
+vaiz/client.py
+vaiz/api/__init__.py
+vaiz/api/base.py
+vaiz/api/boards.py
+vaiz/api/profile.py
+vaiz/api/tasks.py
+vaiz/models/__init__.py
+vaiz/models/base.py
+vaiz/models/boards.py
+vaiz/models/profile.py
+vaiz/models/tasks.py
+vaiz_sdk.egg-info/PKG-INFO
+vaiz_sdk.egg-info/SOURCES.txt
+vaiz_sdk.egg-info/dependency_links.txt
+vaiz_sdk.egg-info/requires.txt
+vaiz_sdk.egg-info/top_level.txt

vaiz_sdk-0.1.0/vaiz_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vaiz_sdk-0.1.0/vaiz_sdk.egg-info/requires.txt

@@ -0,0 +1,7 @@
+requests>=2.31.0
+pydantic>=2.0
+python-dotenv>=0.9.0
+
+[dev]
+pytest>=8.0.0
+pytest-mock>=3.12.0

vaiz_sdk-0.1.0/vaiz_sdk.egg-info/top_level.txt

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