# pks-sdk-python

**Repository Path**: lxc.com/pks-sdk-python

## Basic Information

- **Project Name**: pks-sdk-python
- **Description**: PKS Python SDK — 声明式后端框架的 Python 实现。提供 BaseRepo、Base、Field、12 个装饰器、Scanner、Registry，依赖 pks-kernel 微内核契约。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-04
- **Last Updated**: 2026-06-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# pks-sdk-python

**PKS Python SDK — BaseRepo, Base, Field, 装饰器, Scanner, Registry**

声明式后端框架的 Python 实现 · 依赖 pks-kernel

[![Python 3.11+](https://img.shields.io/badge/Python-3.11+-3776AB.svg)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

</div>

---

## 这是什么？

`pks-sdk-python` 是 [PKS (Pointend Knowledge Store)](https://github.com/lxc512157407/pointend) 平台的 Python 语言 SDK，实现了 `pks-kernel` 定义的所有能力契约。

---

## 核心模块

| 模块 | 职责 |
|------|------|
| `base_repo.py` | BaseRepo — CRUD 仓库基类 |
| `_base_entity.py` | Base — 实体基类 |
| `field.py` | Field() — 声明式字段定义 |
| `base_service.py` | BaseService — 服务层基类 |
| `scanner.py` | 实体扫描器 |
| `registry.py` | 全局注册表 |
| `config.py` | 配置加载器 |
| `lifecycle.py` | 应用生命周期管理 |
| `decorators/` | @endpoint, @mcp_tool, @websocket 等 12 个装饰器 |
| `_db/` | 数据库执行计划 |
| `_sanitizer.py` | 输入净化 |
| `_scope.py` | 安全作用域 |

---

## 快速开始

```bash
pip install pks-sdk-python
```

```python
from pks.sdk.python._base_entity import Base
from pks.sdk.python.field import Field
from pks.sdk.python.base_repo import BaseRepo

class User(Base):
    __tablename__ = "users"
    name: Mapped[str] = Field(50, comment="用户名")
    email: Mapped[str] = Field(120, comment="邮箱", unique=True)
```

---

## 依赖

```
pks-kernel（微内核）
fastapi, sqlalchemy, pydantic, loguru, toml
```

---

## 许可证

[MIT License](LICENSE)