pmflow-shared 0.1.0__tar.gz

pmflow_shared-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+*.egg
+
+# Node
+node_modules/
+.next/
+out/
+
+# IDE
+.vscode/
+.idea/
+
+# Environment
+.env
+.env.local
+.env.*.local
+
+# OS
+.DS_Store
+
+# uv
+uv.lock

pmflow_shared-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: pmflow-shared
+Version: 0.1.0
+Summary: Shared models, schemas, and enums for pmflow
+Project-URL: Repository, https://github.com/zhanglaixian/pmflow
+Author-email: zhanglaixian <zhanglaixian@zhuanzhuan.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: email-validator>=2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: sqlmodel>=0.0.22
+Description-Content-Type: text/markdown
+
+# pmflow-shared
+
+Shared models, schemas, and enums for [pmflow](https://github.com/zhanglaixian/pmflow) — an integrated project management and AI-assisted development platform.
+
+This package is primarily used as a dependency by `pmflow-cli` and `pmflow-server`. You typically don't need to install it directly.
+
+## Installation
+
+```bash
+pip install pmflow-shared
+```

pmflow_shared-0.1.0/README.md

@@ -0,0 +1,11 @@
+# pmflow-shared
+
+Shared models, schemas, and enums for [pmflow](https://github.com/zhanglaixian/pmflow) — an integrated project management and AI-assisted development platform.
+
+This package is primarily used as a dependency by `pmflow-cli` and `pmflow-server`. You typically don't need to install it directly.
+
+## Installation
+
+```bash
+pip install pmflow-shared
+```

pmflow_shared-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "pmflow-shared"
+version = "0.1.0"
+description = "Shared models, schemas, and enums for pmflow"
+requires-python = ">=3.12"
+readme = "README.md"
+license = "MIT"
+authors = [{name = "zhanglaixian", email = "zhanglaixian@zhuanzhuan.com"}]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "sqlmodel>=0.0.22",
+    "pydantic>=2.0",
+    "email-validator>=2.0",
+]
+
+[project.urls]
+Repository = "https://github.com/zhanglaixian/pmflow"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pmflow_shared"]

pmflow_shared-0.1.0/src/pmflow_shared/__init__.py

@@ -0,0 +1 @@
+"""pmflow-shared: Shared models, schemas, and enums."""

pmflow_shared-0.1.0/src/pmflow_shared/constants.py

@@ -0,0 +1,10 @@
+API_V1_PREFIX = "/api/v1"
+
+TOKEN_PREFIX = "pmf_"
+TOKEN_BYTES = 32
+
+PRIORITY_NONE = 0
+PRIORITY_LOW = 1
+PRIORITY_MEDIUM = 2
+PRIORITY_HIGH = 3
+PRIORITY_URGENT = 4

pmflow_shared-0.1.0/src/pmflow_shared/enums.py

@@ -0,0 +1,37 @@
+from enum import Enum
+
+
+class IssueStatus(str, Enum):
+    TODO = "todo"
+    DOING = "doing"
+    DONE = "done"
+    BLOCKED = "blocked"
+
+
+class IssueType(str, Enum):
+    FEATURE = "feature"
+    BUG = "bug"
+    TASK = "task"
+    EPIC = "epic"
+
+
+class ContextType(str, Enum):
+    FEISHU_DOC = "feishu_doc"
+    IMAGE = "image"
+    AUDIO = "audio"
+    MARKDOWN = "markdown"
+    FEISHU_SHEET = "feishu_sheet"
+    EXCEL = "excel"
+    HTML_PROTOTYPE = "html_prototype"
+    OTHER_FILE = "other_file"
+
+
+class WorkspaceRole(str, Enum):
+    OWNER = "owner"
+    ADMIN = "admin"
+    MEMBER = "member"
+
+
+class MessageRole(str, Enum):
+    USER = "user"
+    ASSISTANT = "assistant"

pmflow_shared-0.1.0/src/pmflow_shared/models/__init__.py

@@ -0,0 +1,17 @@
+from pmflow_shared.models.user import User
+from pmflow_shared.models.workspace import Workspace, WorkspaceMember
+from pmflow_shared.models.issue import Issue
+from pmflow_shared.models.context import Context
+from pmflow_shared.models.conversation import Conversation, Message
+from pmflow_shared.models.token import ApiToken
+
+__all__ = [
+    "User",
+    "Workspace",
+    "WorkspaceMember",
+    "Issue",
+    "Context",
+    "Conversation",
+    "Message",
+    "ApiToken",
+]

pmflow_shared-0.1.0/src/pmflow_shared/models/base.py

@@ -0,0 +1,13 @@
+import uuid
+from datetime import datetime
+
+from sqlmodel import Field, SQLModel
+
+
+class TimestampMixin(SQLModel):
+    created_at: datetime = Field(default_factory=datetime.utcnow)
+    updated_at: datetime = Field(default_factory=datetime.utcnow)
+
+
+def new_uuid() -> uuid.UUID:
+    return uuid.uuid4()

pmflow_shared-0.1.0/src/pmflow_shared/models/context.py

@@ -0,0 +1,33 @@
+import uuid
+
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.enums import ContextType
+from pmflow_shared.models.base import TimestampMixin, new_uuid
+
+
+class Context(TimestampMixin, SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    issue_id: uuid.UUID | None = Field(default=None, foreign_key="issue.id", index=True)
+    workspace_id: uuid.UUID | None = Field(default=None, foreign_key="workspace.id", index=True)
+    type: ContextType
+    title: str
+    description: str | None = None
+
+    # type=feishu_doc / feishu_sheet
+    feishu_doc_token: str | None = None
+    feishu_doc_url: str | None = None
+
+    # type=image / audio / excel / other_file
+    storage_key: str | None = None
+    file_name: str | None = None
+    file_size: int | None = None
+    mime_type: str | None = None
+
+    # all types: optional external URL
+    url: str | None = None
+
+    # type=markdown
+    content: str | None = None
+
+    created_by: uuid.UUID = Field(foreign_key="user.id")

pmflow_shared-0.1.0/src/pmflow_shared/models/conversation.py

@@ -0,0 +1,28 @@
+import uuid
+from datetime import datetime
+
+from sqlalchemy import Column
+from sqlalchemy.types import JSON
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.enums import MessageRole
+from pmflow_shared.models.base import new_uuid
+
+
+class Conversation(SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    issue_id: uuid.UUID | None = Field(default=None, foreign_key="issue.id", index=True)
+    workspace_id: uuid.UUID | None = Field(default=None, foreign_key="workspace.id", index=True)
+    title: str
+    purpose: str = Field(default="prd")
+    created_by: uuid.UUID = Field(foreign_key="user.id")
+    created_at: datetime = Field(default_factory=datetime.utcnow)
+
+
+class Message(SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    conversation_id: uuid.UUID = Field(foreign_key="conversation.id", index=True)
+    role: MessageRole
+    content: str
+    extra_data: dict | None = Field(default=None, sa_column=Column("extra_data", JSON))
+    created_at: datetime = Field(default_factory=datetime.utcnow)

pmflow_shared-0.1.0/src/pmflow_shared/models/issue.py

@@ -0,0 +1,20 @@
+import uuid
+
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.enums import IssueStatus, IssueType
+from pmflow_shared.models.base import TimestampMixin, new_uuid
+
+
+class Issue(TimestampMixin, SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    workspace_id: uuid.UUID = Field(foreign_key="workspace.id", index=True)
+    title: str
+    description: str | None = None
+    type: IssueType = Field(default=IssueType.TASK)
+    status: IssueStatus = Field(default=IssueStatus.TODO, index=True)
+    priority: int = Field(default=0)
+    assignee_id: uuid.UUID | None = Field(default=None, foreign_key="user.id")
+    parent_id: uuid.UUID | None = Field(default=None, foreign_key="issue.id")
+    sequence_num: int
+    created_by: uuid.UUID = Field(foreign_key="user.id")

pmflow_shared-0.1.0/src/pmflow_shared/models/token.py

@@ -0,0 +1,20 @@
+import uuid
+from datetime import datetime
+
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.models.base import new_uuid
+
+
+class ApiToken(SQLModel, table=True):
+    __tablename__ = "api_token"
+
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    user_id: uuid.UUID = Field(foreign_key="user.id", index=True)
+    name: str
+    token_hash: str = Field(unique=True, index=True)
+    token_prefix: str
+    last_used_at: datetime | None = None
+    expires_at: datetime | None = None
+    is_active: bool = Field(default=True)
+    created_at: datetime = Field(default_factory=datetime.utcnow)

pmflow_shared-0.1.0/src/pmflow_shared/models/user.py

@@ -0,0 +1,14 @@
+import uuid
+
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.models.base import TimestampMixin, new_uuid
+
+
+class User(TimestampMixin, SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    email: str = Field(unique=True, index=True)
+    name: str
+    hashed_password: str
+    avatar_url: str | None = None
+    is_active: bool = Field(default=True)

pmflow_shared-0.1.0/src/pmflow_shared/models/workspace.py

@@ -0,0 +1,25 @@
+import uuid
+from datetime import datetime
+
+from sqlmodel import Field, SQLModel
+
+from pmflow_shared.enums import WorkspaceRole
+from pmflow_shared.models.base import TimestampMixin, new_uuid
+
+
+class Workspace(TimestampMixin, SQLModel, table=True):
+    id: uuid.UUID = Field(default_factory=new_uuid, primary_key=True)
+    name: str = Field(index=True)
+    slug: str = Field(unique=True, index=True)
+    description: str | None = None
+    created_by: uuid.UUID = Field(foreign_key="user.id")
+    issue_counter: int = Field(default=0)
+
+
+class WorkspaceMember(SQLModel, table=True):
+    __tablename__ = "workspace_member"
+
+    workspace_id: uuid.UUID = Field(foreign_key="workspace.id", primary_key=True)
+    user_id: uuid.UUID = Field(foreign_key="user.id", primary_key=True)
+    role: WorkspaceRole = Field(default=WorkspaceRole.MEMBER)
+    joined_at: datetime = Field(default_factory=datetime.utcnow)

pmflow_shared-0.1.0/src/pmflow_shared/schemas/ai.py

@@ -0,0 +1,34 @@
+import uuid
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from pmflow_shared.enums import MessageRole
+
+
+class ConversationCreate(BaseModel):
+    title: str
+    purpose: str = "prd"
+
+
+class ConversationRead(BaseModel):
+    id: uuid.UUID
+    issue_id: uuid.UUID | None
+    workspace_id: uuid.UUID | None
+    title: str
+    purpose: str
+    created_by: uuid.UUID
+    created_at: datetime
+
+
+class SendMessage(BaseModel):
+    content: str
+
+
+class MessageRead(BaseModel):
+    id: uuid.UUID
+    conversation_id: uuid.UUID
+    role: MessageRole
+    content: str
+    extra_data: dict | None
+    created_at: datetime

pmflow_shared-0.1.0/src/pmflow_shared/schemas/context.py

@@ -0,0 +1,36 @@
+import uuid
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from pmflow_shared.enums import ContextType
+
+
+class ContextCreate(BaseModel):
+    type: ContextType
+    title: str
+    description: str | None = None
+    feishu_doc_token: str | None = None
+    feishu_doc_url: str | None = None
+    url: str | None = None
+    content: str | None = None
+
+
+class ContextRead(BaseModel):
+    id: uuid.UUID
+    issue_id: uuid.UUID | None
+    workspace_id: uuid.UUID | None
+    type: ContextType
+    title: str
+    description: str | None
+    feishu_doc_token: str | None
+    feishu_doc_url: str | None
+    storage_key: str | None
+    file_name: str | None
+    file_size: int | None
+    mime_type: str | None
+    url: str | None
+    content: str | None
+    created_by: uuid.UUID
+    created_at: datetime
+    updated_at: datetime

pmflow_shared-0.1.0/src/pmflow_shared/schemas/issue.py

@@ -0,0 +1,44 @@
+import uuid
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from pmflow_shared.enums import IssueStatus, IssueType
+
+
+class IssueCreate(BaseModel):
+    title: str
+    description: str | None = None
+    type: IssueType = IssueType.TASK
+    priority: int = 0
+    assignee_id: uuid.UUID | None = None
+    parent_id: uuid.UUID | None = None
+
+
+class IssueUpdate(BaseModel):
+    title: str | None = None
+    description: str | None = None
+    type: IssueType | None = None
+    priority: int | None = None
+    assignee_id: uuid.UUID | None = None
+    parent_id: uuid.UUID | None = None
+
+
+class IssueStatusUpdate(BaseModel):
+    status: IssueStatus
+
+
+class IssueRead(BaseModel):
+    id: uuid.UUID
+    workspace_id: uuid.UUID
+    title: str
+    description: str | None
+    type: IssueType
+    status: IssueStatus
+    priority: int
+    assignee_id: uuid.UUID | None
+    parent_id: uuid.UUID | None
+    sequence_num: int
+    created_by: uuid.UUID
+    created_at: datetime
+    updated_at: datetime

pmflow_shared-0.1.0/src/pmflow_shared/schemas/user.py

@@ -0,0 +1,56 @@
+import uuid
+from datetime import datetime
+
+from pydantic import BaseModel, EmailStr
+
+
+class UserCreate(BaseModel):
+    email: EmailStr
+    name: str
+    password: str
+
+
+class UserLogin(BaseModel):
+    email: EmailStr
+    password: str
+
+
+class UserRead(BaseModel):
+    id: uuid.UUID
+    email: str
+    name: str
+    avatar_url: str | None
+    is_active: bool
+    created_at: datetime
+
+
+# --- Auth response schemas ---
+
+
+class AuthResponse(BaseModel):
+    user: UserRead
+    message: str = "ok"
+
+
+# --- API Token schemas ---
+
+
+class TokenCreate(BaseModel):
+    name: str
+    expires_in_days: int | None = None
+
+
+class TokenRead(BaseModel):
+    id: uuid.UUID
+    name: str
+    token_prefix: str
+    last_used_at: datetime | None
+    expires_at: datetime | None
+    is_active: bool
+    created_at: datetime
+
+
+class TokenCreated(TokenRead):
+    """Only returned once at creation time — includes the plain-text token."""
+
+    plain_token: str

pmflow_shared-0.1.0/src/pmflow_shared/schemas/workspace.py

@@ -0,0 +1,38 @@
+import uuid
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from pmflow_shared.enums import WorkspaceRole
+
+
+class WorkspaceCreate(BaseModel):
+    name: str
+    slug: str
+    description: str | None = None
+
+
+class WorkspaceUpdate(BaseModel):
+    name: str | None = None
+    description: str | None = None
+
+
+class WorkspaceRead(BaseModel):
+    id: uuid.UUID
+    name: str
+    slug: str
+    description: str | None
+    created_by: uuid.UUID
+    created_at: datetime
+    updated_at: datetime
+
+
+class WorkspaceMemberAdd(BaseModel):
+    user_id: uuid.UUID
+    role: WorkspaceRole = WorkspaceRole.MEMBER
+
+
+class WorkspaceMemberRead(BaseModel):
+    user_id: uuid.UUID
+    role: WorkspaceRole
+    joined_at: datetime