ava-data-models 0.1.0__tar.gz

ava_data_models-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 AVACloud Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ava_data_models-0.1.0/PKG-INFO

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: ava-data-models
+Version: 0.1.0
+Summary: AVACloud 业务领域公共 Pydantic v2 数据模型包
+Author: AVACloud Team
+License: Apache-2.0
+Project-URL: Homepage, https://gitea.avacloud.com.cn/AVA-AIA/ava-data-models
+Project-URL: Repository, https://gitea.avacloud.com.cn/AVA-AIA/ava-data-models
+Project-URL: Issues, https://gitea.avacloud.com.cn/AVA-AIA/ava-data-models/issues
+Keywords: ava,avacloud,pydantic,models,ibas,business-objects
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0,>=2.0
+Requires-Dist: pydantic-settings<3.0,>=2.0
+Requires-Dist: typing-extensions>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Dynamic: license-file
+
+# ava-data-models
+
+AVACloud 业务领域公共 Pydantic v2 数据模型包。
+
+## 项目定位
+
+`ava-data-models` 是 AVACloud 生态下的**公共业务对象模型层**，仅存放：
+
+- Pydantic v2 业务对象数据模型
+- 业务对象公共基类
+
+**不包含**业务枚举、查询条件、分页、批量操作、通用请求/响应包装，也不包含任何业务查询、校验逻辑、持久化或外部服务调用，作为各智能体项目的公共依赖被引用。
+
+## 技术栈
+
+- Python >= 3.10
+- Pydantic v2
+- pydantic-settings
+- typing-extensions
+
+## 安装
+
+```bash
+# 作为依赖安装（发布到 PyPI 后）
+pip install ava-data-models
+
+# 本地开发安装
+pip install -e ".[dev]"
+```
+
+## 目录结构
+
+```text
+ava-data-models/
+├── pyproject.toml
+├── README.md
+├── scripts/
+│   ├── generate_from_dts.py    # 从 ibas index.d.ts 自动生成模型
+│   └── generate_inits.py       # 生成业务模块 __init__.py
+├── src/
+│   └── ava_data_models/
+│       ├── __init__.py         # 根包导出：公共业务对象基类
+│       ├── common/             # 公共基础
+│       │   └── base.py         # BusinessObject / Document / DocumentLine / MasterData / ...
+│       ├── accounting/
+│       ├── apparelindustry/
+│       ├── approvalprocess/
+│       ├── budget/
+│       ├── businesspartner/
+│       ├── cargos/
+│       ├── channels/
+│       ├── dealer/
+│       ├── documents/
+│       ├── equipment/
+│       ├── groupfinancemanagement/
+│       ├── humanresources/
+│       ├── importexport/
+│       ├── initialfantasy/
+│       ├── integration/
+│       ├── invoice/
+│       ├── manufacturing/
+│       ├── manufacturingcost/
+│       ├── manufacturingoutsourcing/
+│       ├── manufacturingscheduling/
+│       ├── marketingpromotion/
+│       ├── masterdata/
+│       ├── materials/
+│       ├── membercenter/
+│       ├── message/
+│       ├── product/
+│       ├── projectsystem/
+│       ├── purchase/
+│       ├── qualitycontrol/
+│       ├── receiptpayment/
+│       ├── reimbursement/
+│       ├── reportanalysis/
+│       ├── sales/
+│       ├── salesopportunity/
+│       ├── servicecenter/
+│       ├── shopping/
+│       ├── store/
+│       ├── supplier/
+│       ├── taxation/
+│       ├── thirdpartyapp/
+│       └── ...                 # 每个业务模块独立分包
+└── tests/
+    └── test_common.py
+```
+
+## 命名规范
+
+- 类名：大驼峰（CamelCase），例如 `SalesOrder`、`PurchaseRequestItem`。
+- 属性名：下划线命名（snake_case），例如 `doc_entry`、`customer_code`。
+- 通过 `Field(..., alias="camelCase")` 保留原始 ibas API 字段名，支持直接反序列化来自 ibas 的 camelCase JSON。
+
+## 业务对象基类层次
+
+模型基类与 ibas 业务对象体系对齐：
+
+```text
+BusinessObject
+├── MasterData          # 对应 ibas.IBOMasterData
+├── MasterDataLine      # 对应 ibas.IBOMasterDataLine
+├── Document            # 对应 ibas.IBODocument
+├── DocumentLine        # 对应 ibas.IBODocumentLine
+├── Simple              # 对应 ibas.IBOSimple
+└── SimpleLine          # 对应 ibas.IBOSimpleLine
+```
+
+- `BusinessObject` 携带 `source_system` / `fetched_at` 跨系统溯源元信息。
+- 生成器**仅对直接继承上述 `ibas.IBO*` 接口的类生成模型**。
+- 集合壳类（如 `ISalesOrderItems`）不再保留，字段统一用 `list[T]` 表示。
+
+## 使用示例
+
+### 1. 导入公共基础模型
+
+```python
+from ava_data_models import BusinessObject, Document
+```
+
+### 2. 导入业务模块模型
+
+```python
+from ava_data_models.sales import SalesOrder, SalesOrderItem
+from ava_data_models.purchase import PurchaseOrder, PurchaseRequest
+from ava_data_models.materials import Material, Warehouse
+from ava_data_models.manufacturing import ProductionOrder
+```
+
+### 3. 直接解析 ibas API 返回的 camelCase JSON
+
+```python
+import json
+from ava_data_models.sales import SalesOrder
+
+payload = {
+    "docEntry": 10001,
+    "docNum": "SO-2024-0001",
+    "customerCode": "C001",
+    "customerName": "示例客户",
+    "documentTotal": 1250.00,
+    "salesOrderItems": [
+        {"itemCode": "P001", "quantity": 10.0, "price": 125.0},
+    ],
+}
+
+order = SalesOrder.model_validate(payload)
+print(order.doc_entry)       # 10001
+print(order.customer_code)   # C001
+print(order.document_total)  # 1250.0
+print(len(order.sales_order_items))  # 1
+```
+
+### 4. 序列化为 snake_case 或 camelCase
+
+```python
+# 默认输出 snake_case
+order.model_dump()
+
+# 输出 camelCase（使用 alias）
+order.model_dump(by_alias=True)
+
+# JSON 字符串
+order.model_dump_json(by_alias=True)
+```
+
+## 模型生成脚本
+
+本项目提供 `scripts/generate_from_dts.py`，可基于本地 `ibas-typescript/test/apps/{module}/index.d.ts` 中的 `bo` 命名空间自动生成对应业务模块的 Pydantic 模型。
+
+### 生成范围
+
+仅对 `bo` 命名空间中**直接继承 `ibas.IBO*` 业务对象接口**的类生成模型：
+
+| ibas 接口 | Python 基类 |
+|---|---|
+| `ibas.IBusinessObject` | `BusinessObject` |
+| `ibas.IBODocument` | `Document` |
+| `ibas.IBODocumentLine` | `DocumentLine` |
+| `ibas.IBOMasterData` | `MasterData` |
+| `ibas.IBOMasterDataLine` | `MasterDataLine` |
+| `ibas.IBOSimple` | `Simple` |
+| `ibas.IBOSimpleLine` | `SimpleLine` |
+
+集合壳类（如 `ISalesOrderItems`）不生成独立模型，相关字段统一用 `list[T]` 表示。
+
+### 前提
+
+- 本地存在 ibas TypeScript 测试应用目录，默认路径：
+  `/Users/Niuren.Zhu/Codes/ColorCoding/ibas-typescript/test/apps`
+- 可通过环境变量覆盖：
+  `export IBAS_TEST_APPS=/path/to/ibas-typescript/test/apps`
+
+### 生成全部模块
+
+```bash
+python scripts/generate_from_dts.py
+python scripts/generate_inits.py
+```
+
+### 生成单个模块
+
+```bash
+# 修改 generate_from_dts.py 中的 MODULES 列表，仅保留目标模块后执行
+python scripts/generate_from_dts.py
+python scripts/generate_inits.py
+```
+
+### 生成后注意事项
+
+- 生成器为**尽力解析**，复杂的泛型、方法、跨模块引用会降级为 `Any`。
+- 集合类（如 `ISalesOrderItems`）会启发式转换为 `list[SalesOrderItem]`。
+- 生成后建议人工复核关键字段类型与注释，必要时手工补充或修正。
+
+## 开发
+
+```bash
+# 创建虚拟环境
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest tests/ -v
+
+# 代码格式化（可选）
+black src tests
+ruff check src tests --fix
+```
+
+## 发布到 PyPI
+
+```bash
+# 1. 安装构建与上传工具
+pip install build twine
+
+# 2. 清理历史构建产物
+rm -rf dist/ build/ *.egg-info
+
+# 3. 构建源码分发包与 Wheel
+python -m build
+
+# 4. 先上传到 TestPyPI 验证（可选）
+python -m twine upload --repository testpypi dist/*
+
+# 5. 上传到正式 PyPI
+python -m twine upload dist/*
+```
+
+上传前请确认：
+
+- `pyproject.toml` 中的 `version` 已更新。
+- 已配置 PyPI API token（`~/.pypirc` 或通过 `twine login`）。
+
+## 贡献与维护
+
+- 新增业务模块：在 `src/ava_data_models/` 下新增分包，参照现有模块结构编写 `models.py` 与 `__init__.py`。
+- 修改公共模型：优先在 `common/` 中定义，并在 `common/__init__.py` 与根包 `__init__.py` 中导出。
+- 保持**只存放业务对象模型**，不引入枚举、查询条件、分页、批量操作、业务逻辑、数据库查询或外部 HTTP 调用。
+
+## 许可证
+
+[Apache License 2.0](LICENSE)