PyREUser3 0.1.0__tar.gz → 0.3.0__tar.gz

pyreuser3-0.3.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: PyREUser3
+Version: 0.3.0
+Summary: Pure Python tools for converting RE Engine .user.3 files to and from JSON.
+Author: Egg Targaryen
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dzxrly/PyREUser3
+Project-URL: Repository, https://github.com/dzxrly/PyREUser3
+Project-URL: Issues, https://github.com/dzxrly/PyREUser3/issues
+Keywords: RE Engine,user.3,JSON,modding,RSZ
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: File Formats
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# PyREUser3
+
+PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
+
+## Installation
+
+```bash
+pip install pyreuser3
+```
+
+## What Is Included
+
+- `.user.3 -> JSON` export.
+- `JSON -> .user.3` packing.
+- A reusable Python API through `REUser3Converter`.
+- CLI commands through `pyreuser3`.
+- A local `.user.3` export Web UI through `pyreuser3-web`.
+
+The published package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts. You need to provide data files that match the target game and version.
+
+## Requirements
+
+- Python 3.9 or newer.
+- A RE_RSZ schema JSON file for the target game/version.
+- An `il2cpp_dump.json` file when exporting readable enum labels.
+- One or more unpacked `.user.3` files.
+
+## Usage
+
+Usage details may change as the package evolves. For the latest command-line and Python API examples, read the GitHub README:
+
+https://github.com/dzxrly/PyREUser3#readme
+
+## Links
+
+- Homepage: https://github.com/dzxrly/PyREUser3
+- Issues: https://github.com/dzxrly/PyREUser3/issues
+- License: MIT License

pyreuser3-0.3.0/PyREUser3.egg-info/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: PyREUser3
+Version: 0.3.0
+Summary: Pure Python tools for converting RE Engine .user.3 files to and from JSON.
+Author: Egg Targaryen
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dzxrly/PyREUser3
+Project-URL: Repository, https://github.com/dzxrly/PyREUser3
+Project-URL: Issues, https://github.com/dzxrly/PyREUser3/issues
+Keywords: RE Engine,user.3,JSON,modding,RSZ
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: File Formats
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=13.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# PyREUser3
+
+PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
+
+## Installation
+
+```bash
+pip install pyreuser3
+```
+
+## What Is Included
+
+- `.user.3 -> JSON` export.
+- `JSON -> .user.3` packing.
+- A reusable Python API through `REUser3Converter`.
+- CLI commands through `pyreuser3`.
+- A local `.user.3` export Web UI through `pyreuser3-web`.
+
+The published package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts. You need to provide data files that match the target game and version.
+
+## Requirements
+
+- Python 3.9 or newer.
+- A RE_RSZ schema JSON file for the target game/version.
+- An `il2cpp_dump.json` file when exporting readable enum labels.
+- One or more unpacked `.user.3` files.
+
+## Usage
+
+Usage details may change as the package evolves. For the latest command-line and Python API examples, read the GitHub README:
+
+https://github.com/dzxrly/PyREUser3#readme
+
+## Links
+
+- Homepage: https://github.com/dzxrly/PyREUser3
+- Issues: https://github.com/dzxrly/PyREUser3/issues
+- License: MIT License

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/PyREUser3.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ PyREUser3.egg-info/dependency_links.txt
 PyREUser3.egg-info/entry_points.txt
 PyREUser3.egg-info/requires.txt
 PyREUser3.egg-info/top_level.txt
+docs/PYPI.md
 docs/README.zh-CN.md
 pyreuser3/__init__.py
 pyreuser3/__main__.py

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/README.md

@@ -1,6 +1,15 @@
-# PyREUser3
+<h1 align="center">PyREUser3</h1>
 
-English | [简体中文](./docs/README.zh-CN.md)
+<p align="center">
+  English | <a href="https://github.com/dzxrly/PyREUser3/blob/main/docs/README.zh-CN.md">简体中文</a>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/PyREUser3/"><img alt="PyPI Project" src="https://img.shields.io/badge/PyPI-PyREUser3-blue"></a>
+  <a href="https://pypi.org/project/PyREUser3/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/PyREUser3"></a>
+  <a href="https://pepy.tech/project/PyREUser3"><img alt="Downloads" src="https://static.pepy.tech/badge/PyREUser3"></a>
+  <a href="https://github.com/dzxrly/PyREUser3/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/PyREUser3"></a>
+</p>
 
 PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
 
@@ -86,6 +95,22 @@ converter.pack_file(
 )
 ```
 
+Convert a `.user.3` file to an in-memory JSON-compatible Python object without writing a JSON file:
+
+```python
+readable_data = converter.user3_to_json(
+    "input/OtomonData.user.3",
+    json_format="readable",
+)
+
+repack_data = converter.user3_to_json(
+    "input/OtomonData.user.3",
+    json_format="repack",
+)
+```
+
+Use `json_format="readable"` for the same shape produced by `export_file()`, or `json_format="repack"` for the full instance-table document accepted by `pack()`.
+
 For stable patch-and-repack workflows, use `patch_file()` or `parse_pack_file()`:
 
 ```python

pyreuser3-0.3.0/docs/PYPI.md

@@ -0,0 +1,38 @@
+# PyREUser3
+
+PyREUser3 is a pure Python package for converting RE Engine `.user.3` database files to JSON and packing compatible JSON back to `.user.3`.
+
+## Installation
+
+```bash
+pip install pyreuser3
+```
+
+## What Is Included
+
+- `.user.3 -> JSON` export.
+- `JSON -> .user.3` packing.
+- A reusable Python API through `REUser3Converter`.
+- CLI commands through `pyreuser3`.
+- A local `.user.3` export Web UI through `pyreuser3-web`.
+
+The published package intentionally does not include game resources, dumped game data, RE_RSZ templates, `il2cpp_dump.json`, `.msg.23` conversion tools, or repository-specific helper scripts. You need to provide data files that match the target game and version.
+
+## Requirements
+
+- Python 3.9 or newer.
+- A RE_RSZ schema JSON file for the target game/version.
+- An `il2cpp_dump.json` file when exporting readable enum labels.
+- One or more unpacked `.user.3` files.
+
+## Usage
+
+Usage details may change as the package evolves. For the latest command-line and Python API examples, read the GitHub README:
+
+https://github.com/dzxrly/PyREUser3#readme
+
+## Links
+
+- Homepage: https://github.com/dzxrly/PyREUser3
+- Issues: https://github.com/dzxrly/PyREUser3/issues
+- License: MIT License

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/docs/README.zh-CN.md

@@ -1,6 +1,15 @@
-# PyREUser3
+<h1 align="center">PyREUser3</h1>
 
-[English](../README.md) | 简体中文
+<p align="center">
+  <a href="https://github.com/dzxrly/PyREUser3/blob/main/README.md">English</a> | 简体中文
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/PyREUser3/"><img alt="PyPI 项目" src="https://img.shields.io/badge/PyPI-PyREUser3-blue"></a>
+  <a href="https://pypi.org/project/PyREUser3/"><img alt="PyPI 版本" src="https://img.shields.io/pypi/v/PyREUser3"></a>
+  <a href="https://pepy.tech/project/PyREUser3"><img alt="下载量" src="https://static.pepy.tech/badge/PyREUser3"></a>
+  <a href="https://github.com/dzxrly/PyREUser3/blob/main/LICENSE"><img alt="许可证" src="https://img.shields.io/pypi/l/PyREUser3"></a>
+</p>
 
 PyREUser3 是一个纯 Python 包，用于在 RE Engine 的 `.user.3` 数据库文件和 JSON 之间进行双向转换。
 
@@ -115,6 +124,22 @@ converter.pack_file(
 )
 ```
 
+不写入 JSON 文件，直接把 `.user.3` 转成内存中的 JSON 兼容 Python 对象：
+
+```python
+readable_data = converter.user3_to_json(
+    "input/OtomonData.user.3",
+    json_format="readable",
+)
+
+repack_data = converter.user3_to_json(
+    "input/OtomonData.user.3",
+    json_format="repack",
+)
+```
+
+使用 `json_format="readable"` 时返回与 `export_file()` 一致的可读导出结构；使用 `json_format="repack"` 时返回可传给 `pack()` 的完整实例表结构。
+
 批量处理目录：
 
 ```python

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyREUser3"
-version = "0.1.0"
+version = "0.3.0"
 description = "Pure Python tools for converting RE Engine .user.3 files to and from JSON."
-readme = "README.md"
+readme = "docs/PYPI.md"
 requires-python = ">=3.9"
 license = "MIT"
 license-files = ["LICENSE"]

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/pyreuser3/__init__.py

@@ -1,8 +1,7 @@
-"""RE User3 JSON 工具包的公开导出入口。
+"""Expose the stable public API while keeping expensive converter modules lazy.
 
-较重的转换模块会依赖 Rich 等命令行显示库。这里使用惰性导出，
-让 `pyreuser3-web --help` 和 `python -m pyreuser3.web --help` 这类轻量入口
-不需要提前加载完整导出器或封包器。
+The package-level __getattr__ hook avoids importing Rich and binary conversion code for
+lightweight operations such as version checks and Web UI help output.
 """
 
 from __future__ import annotations
@@ -40,25 +39,19 @@ _EXPORT_MODULES = {
 
 
 def __getattr__(name: str) -> Any:
-    """首次访问公开名称时再惰性导入对应模块。
+    """Resolve a lazily exported package attribute on first access.
 
-    PEP 562 的模块级 ``__getattr__`` 钩子：仅当访问 ``__all__`` 中声明的名称
-    且该名称尚未缓存到模块全局时才会触发，从而实现按需导入的惰性导出。
+    Args:
+        name (str): Symbolic schema, class, field, or enum name being stored or looked up.
 
-    参数：
-        name (str): 正在访问的属性名（通常是 ``__all__`` 中的某个公开名称）。
-
-    返回：
-        Any: 解析并缓存后的目标对象（类、函数或常量）。
-
-    异常：
-        AttributeError: 当 ``name`` 不在惰性导出表 ``_EXPORT_MODULES`` 中时抛出。
+    Returns:
+        Any: Normalized value ready for the next parse, export, post-processing, or pack step.
     """
     module_name = _EXPORT_MODULES.get(name)
     if module_name is None:
         raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
 
-    # 导入后把结果缓存到 globals，后续访问不再触发 __getattr__。
+    # Cache the resolved object in globals so later attribute access bypasses __getattr__ and avoids another import.
     module = import_module(module_name, __name__)
     value = getattr(module, name)
     globals()[name] = value

{pyreuser3-0.1.0 → pyreuser3-0.3.0}/pyreuser3/__main__.py

@@ -1,4 +1,5 @@
-"""Run the PyREUser3 CLI with ``python -m pyreuser3``."""
+"""Provide helpers for __main__.
+"""
 
 from __future__ import annotations