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 部署
-
安装 uv
# macOS/Linux curl -LsSf https://astral.sh/uv/install.sh | sh # Windows powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
-
克隆 monorepo
git clone https://github.com/SeerAPI/seerapi.git cd seerapi
-
安装依赖
# 同步所有工作区依赖 uv sync
-
运行开发环境
# 仅在本包环境中运行 uv run --package seerapi-models python # 运行测试 uv run --package seerapi-models pytest # 运行代码检查 uv run ruff check . uv run ruff format .
开发容器 (推荐)
项目提供了 Dev Container 配置,支持一键部署开发环境:
- 使用 VS Code 打开 monorepo 根目录
- 安装 Dev Containers 扩展
- 按
Ctrl+Shift+P打开命令面板 - 选择 "Dev Containers: Reopen in Container"
容器会自动安装:
- Python 3.10
- uv 包管理器
- pnpm 包管理器
- Ruff 代码检查工具
- 相关 VS Code 扩展
环境要求
- Python >= 3.10
- uv(推荐使用最新版)
许可证
本项目基于 MIT License 开源。
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
seerapi_models-106.8.0.tar.gz
(34.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file seerapi_models-106.8.0.tar.gz.
File metadata
- Download URL: seerapi_models-106.8.0.tar.gz
- Upload date:
- Size: 34.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be6e64695af0d50a9cf34aa85e444f6d196c68182b28b61e2ec13ec98b44ed54
|
|
| MD5 |
101b05c2748902574a0a3750872abb16
|
|
| BLAKE2b-256 |
64a269cb982d55066863c360bc2d129b343310ff54ebae801513f0c6169777d0
|
File details
Details for the file seerapi_models-106.8.0-py3-none-any.whl.
File metadata
- Download URL: seerapi_models-106.8.0-py3-none-any.whl
- Upload date:
- Size: 56.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f533f84adc8f24f34616c02c3aee7b8a71b02312d4f9942f4b99971d00a7fa3c
|
|
| MD5 |
9afa62d41c5ac5024b8b34a52d36022c
|
|
| BLAKE2b-256 |
0a7676f7678b6cda03c15f22474b1fd42e0b66bcf971370f0a09aa5f4384069e
|