feat: workspace and project resources added

Author: sriramveeraghanta

examples/basic_usage.py

@@ -1,106 +1,86 @@
-"""Basic usage examples for the API SDK."""
+"""Basic usage examples for the API SDK (Project info)."""
 
 import asyncio
 import os
 from plane import Client, Config, SyncClient
-from plane.models.user import UserCreate, UserUpdate
 
 
 async def async_example():
-    """Example using async client."""
-    # Initialize client with config
+    """Example using async client for projects."""
     config = Config(
         api_key=os.getenv("MY_API_KEY", "your-api-key"),
         base_url="https://api.plane.so/api/v1",
     )
 
-    # Or initialize from environment variables
-    # client = Client()  # Uses MY_API_KEY env var
-
     async with Client(config) as client:
         # Check API health
         health = await client.health_check()
         print(f"API Health: {health}")
 
-        # List users
-        result = await client.users.list(page=1, per_page=10)
-        users = result["users"]
-        pagination = result["pagination"]
-
+        # List workspaces
+        ws_result = await client.workspaces.list(page=1, per_page=5)
+        workspaces = ws_result["workspaces"]
+        if not workspaces:
+            print("No workspaces found.")
+            return
+        workspace = workspaces[0]
+        print(f"Using workspace: {workspace.name} (slug: {workspace.slug})")
+
+        # List projects in the workspace
+        proj_result = await client.projects.list(workspace.slug, page=1, per_page=10)
+        projects = proj_result["projects"]
+        pagination = proj_result["pagination"]
         print(
-            f"Found {len(users)} users (page {pagination.page} of {pagination.total_pages})"
-        )
-
-        # Get a specific user
-        if users:
-            user = await client.users.get(users[0].id)
-            print(f"User: {user.full_name} ({user.email})")
-
-        # Create a new user
-        new_user_data = UserCreate(
-            email="[email protected]",
-            firstName="New",
-            lastName="User",
-            password="securepassword123",
+            f"Found {len(projects)} projects (page {pagination.page} of {pagination.total_pages})"
         )
+        for project in projects:
+            print(f"- {project.name} (id: {project.id}, desc: {project.description})")
 
-        try:
-            new_user = await client.users.create(new_user_data)
-            print(f"Created user: {new_user.id}")
-
-            # Update the user
-            update_data = UserUpdate(firstName="Updated")
-            updated_user = await client.users.update(new_user.id, update_data)
-            print(f"Updated user: {updated_user.full_name}")
-
-            # Search users
-            search_results = await client.users.search("Updated", limit=5)
-            print(f"Search found {len(search_results)} users")
-
-            # Delete the user
-            await client.users.delete(new_user.id)
-            print("User deleted")
-
-        except Exception as e:
-            print(f"Error: {e}")
+        # Get a specific project (first one)
+        if projects:
+            project = await client.projects.get(workspace.slug, projects[0].id)
+            print(
+                f"Project details: {project.name} (id: {project.id}) - {project.description}"
+            )
 
 
 def sync_example():
-    """Example using synchronous client."""
+    """Example using synchronous client for projects."""
     config = Config(
         api_key=os.getenv("MY_API_KEY", "your-api-key"),
-        base_url="https://api.example.com/v1",
+        base_url="https://api.plane.so/api/v1",
     )
 
     with SyncClient(config) as client:
         # Check API health
         health = client.health_check()
         print(f"API Health: {health}")
 
-        # List users
-        result = client.users.list(page=1, per_page=5)
-        users = result["users"]
-
-        print(f"Found {len(users)} users")
-
-        # Create and manage a user
-        new_user_data = UserCreate(
-            email="[email protected]",
-            firstName="Sync",
-            lastName="User",
-            password="securepassword123",
+        # List workspaces
+        ws_result = client.workspaces.list(page=1, per_page=5)
+        workspaces = ws_result["workspaces"]
+        if not workspaces:
+            print("No workspaces found.")
+            return
+        workspace = workspaces[0]
+        print(f"Using workspace: {workspace.name} (slug: {workspace.slug})")
+
+        # List projects in the workspace
+        proj_result = client.projects.list(workspace.slug, page=1, per_page=10)
+        projects = proj_result["projects"]
+        pagination = proj_result["pagination"]
+        print(
+            f"Found {len(projects)} projects (page {pagination.page} of {pagination.total_pages})"
         )
-
-        try:
-            new_user = client.users.create(new_user_data)
-            print(f"Created user: {new_user.full_name}")
-
-            # Clean up
-            client.users.delete(new_user.id)
-            print("User deleted")
-
-        except Exception as e:
-            print(f"Error: {e}")
+        for project in projects:
+            print(f"- {project.name} (id: {project.id}, desc: {project.description})")
+
+        # Get a specific project (first one)
+        if projects:
+            project = client.projects.get(workspace.slug, projects[0].id)
+            print(
+                f"Project details: {project.name} (id: {project.id}) - {project.description}"
+            )
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -28,7 +28,7 @@ dev = [
     "pytest>=7.0.0",
     "pytest-asyncio>=0.21.0",
     "pytest-cov>=4.0.0",
-    "black>=23.0.0",
+    "ruff>=0.0.290",
     "isort>=5.12.0",
     "flake8>=6.0.0",
     "mypy>=1.0.0",
@@ -40,9 +40,71 @@ Documentation = "https://github.com/makeplane/sdk-python"
 Repository = "https://github.com/makeplane/sdk-python"
 Issues = "https://github.com/makeplane/sdk-python/issues"
 
-[tool.black]
+[tool.ruff]
 line-length = 88
-target-version = ['py38']
+target-version = "py38"
+
+[tool.ruff.format]
+# Use double quotes for strings.
+quote-style = "double"
+
+# Indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Respect magic trailing commas.
+# skip-magic-trailing-comma = true
+
+# Automatically detect the appropriate line ending.
+line-ending = "auto"
+
+[tool.ruff.lint]
+# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
+select = ["E", "F"]
+ignore = []
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.pep8-naming]
+# Allow lowercase variables like "id"
+classmethod-decorators = ["classmethod", "validator", "root_validator"]
+
+[tool.ruff.lint.per-file-ignores]
+# Ignore specific rules for tests
+"tests/*" = ["E402", "F401", "F811"]
+# Ignore imported but unused in __init__.py files
+"__init__.py" = ["F401"]
+
+[tool.ruff.lint.mccabe]
+# Unlike Flake8, default to a complexity level of 10.
+max-complexity = 10
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+detect-same-package = true
+force-wrap-aliases = true
+known-first-party = ["plane"]
+known-third-party = ["rest_framework"]
+relative-imports-order = "closest-to-furthest"
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "parents"
+
+[tool.ruff.lint.pycodestyle]
+ignore-overlong-task-comments = true
+max-doc-length = 88
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pylint]
+max-args = 8
+max-statements = 50
+
 
 [tool.isort]
 profile = "black"

src/plane/client.py

@@ -4,7 +4,8 @@
 from typing import Optional
 import httpx
 from .config import Config
-from .resources.users import UsersResource
+from .resources.workspaces import UsersResource
+from .resources.projects import ProjectsResource
 
 
 class Client:
@@ -20,6 +21,7 @@ def __init__(self, config: Optional[Config] = None, **kwargs):
 
         # Initialize resources
         self.users = UsersResource(self)
+        self.projects = ProjectsResource(self)
 
     def _create_http_client(self) -> httpx.AsyncClient:
         """Create HTTP client with proper configuration."""
@@ -85,6 +87,11 @@ def users(self):
         """Access users resource synchronously."""
         return SyncUsersResource(self._async_client.users)
 
+    @property
+    def projects(self):
+        """Access projects resource synchronously."""
+        return SyncProjectsResource(self._async_client.projects)
+
     def health_check(self) -> dict:
         """Check API health synchronously."""
         return self._run_async(self._async_client.health_check())
@@ -141,3 +148,46 @@ def delete(self, user_id: str):
     def search(self, query: str, limit: int = 10):
         """Search users synchronously."""
         return self._run_async(self._async_resource.search(query, limit))
+
+
+class SyncProjectsResource:
+    """Synchronous wrapper for projects resource."""
+
+    def __init__(self, async_resource: ProjectsResource):
+        self._async_resource = async_resource
+        self._client = async_resource._client
+
+    def _run_async(self, coro):
+        try:
+            loop = asyncio.get_event_loop()
+        except RuntimeError:
+            loop = asyncio.new_event_loop()
+            asyncio.set_event_loop(loop)
+        return loop.run_until_complete(coro)
+
+    def list(
+        self,
+        workspace_slug: str,
+        page: int = 1,
+        per_page: int = 20,
+        search: Optional[str] = None,
+    ):
+        return self._run_async(
+            self._async_resource.list(workspace_slug, page, per_page, search)
+        )
+
+    def get(self, workspace_slug: str, project_id: str):
+        return self._run_async(self._async_resource.get(workspace_slug, project_id))
+
+    def create(self, workspace_slug: str, project_data):
+        return self._run_async(
+            self._async_resource.create(workspace_slug, project_data)
+        )
+
+    def update(self, workspace_slug: str, project_id: str, project_data):
+        return self._run_async(
+            self._async_resource.update(workspace_slug, project_id, project_data)
+        )
+
+    def delete(self, workspace_slug: str, project_id: str):
+        return self._run_async(self._async_resource.delete(workspace_slug, project_id))

src/plane/models/__init__.py

@@ -1,13 +1,12 @@
 """Models package."""
 
 from .base import BaseAPIModel, TimestampMixin, PaginatedResponse
-from .user import User, UserCreate, UserUpdate
+from .workspace import Workspace, WorkspaceUpdate
 
 __all__ = [
     "BaseAPIModel",
     "TimestampMixin",
     "PaginatedResponse",
-    "User",
-    "UserCreate",
-    "UserUpdate",
+    "Workspace",
+    "WorkspaceUpdate",
 ]