Skip to main content

seerapi-models

SeerAPI 数据模型/ORM 定义,用于前后端开发。

安装

使用 uv:

uv add seerapi-models

或者使用 pip:

pip install seerapi-models

也可以使用其他包管理器,如 poetry 等。

使用

from seerapi_models import Item, ItemORM, ItemCategory, ResourceRef

category_ref = ResourceRef.from_model(ItemCategory, id=1) # 定义物品分类字段引用
item = Item(
    id=1,
    name="Item 1",
    max=100,
    category=catgeory_ref
)

print(item.name)

assert isinstance(item.to_orm(), ItemORM) # 转换为 ORM 模型

开发环境部署

本包是 SeerAPI monorepo 的一部分。推荐从 monorepo 根目录进行开发。

使用 uv 部署

  1. 安装 uv

    # macOS/Linux
    curl -LsSf https://astral.sh/uv/install.sh | sh
    
    # Windows
    powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
    
  2. 克隆 monorepo

    git clone https://github.com/SeerAPI/seerapi.git
    cd seerapi
    
  3. 安装依赖

    # 同步所有工作区依赖
    uv sync
    
  4. 运行开发环境

    # 仅在本包环境中运行
    uv run --package seerapi-models python
    
    # 运行测试
    uv run --package seerapi-models pytest
    
    # 运行代码检查
    uv run ruff check .
    uv run ruff format .
    

开发容器 (推荐)

项目提供了 Dev Container 配置,支持一键部署开发环境:

  1. 使用 VS Code 打开 monorepo 根目录
  2. 安装 Dev Containers 扩展
  3. 按 Ctrl+Shift+P 打开命令面板
  4. 选择 "Dev Containers: Reopen in Container"

容器会自动安装:

  • Python 3.10
  • uv 包管理器
  • pnpm 包管理器
  • Ruff 代码检查工具
  • 相关 VS Code 扩展

环境要求

  • Python >= 3.10
  • uv(推荐使用最新版)

许可证

本项目基于 MIT License 开源。

Metadata

Release files for seerapi-models 106.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for seerapi-models 106.10.0
File Size Uploaded
seerapi_models-106.10.0.tar.gz 34.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for seerapi-models 106.10.0
File Interpreter ABI Platform
seerapi_models-106.10.0-py3-none-any.whl Python 3 none any Details

Total release size: 91.4 kB

Release files / seerapi_models-106.10.0.tar.gz

Download URL seerapi_models-106.10.0.tar.gz
Size 34.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9a58a10588a0701d1b6a905826b5d0c533f037c9799efd99aa64a9f25cf3cfa7
BLAKE2b-256 checksum
How to use checksums
867f32fea20cd7af5f80770d182dafeb3686210e12946112bbe9298fb5787074
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / seerapi_models-106.10.0-py3-none-any.whl

Download URL seerapi_models-106.10.0-py3-none-any.whl
Size 57.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
279cd17914f8cbfa8509daa7de418568efefff15bdcfc1f7afbc6077343a608f
BLAKE2b-256 checksum
How to use checksums
b17de1f793c30030a30dd90b5c2a6e89696026dbca7db4377b44cd11a15d4304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page