TextGrocery-Shop 0.2.0__tar.gz

textgrocery_shop-0.2.0/AGENTS.md

@@ -0,0 +1,39 @@
+# AGENTS.md
+
+面向维护者的项目约定。用户文档：`README.md`（中文，默认）/ `README_EN.md`（英文）。
+
+## 身份约定
+
+- PyPI 发行名：`TextGrocery_Shop`，pip 规范化为 `textgrocery-shop`。
+- Python 导入名：`tgrocery`（不要改包目录名，旧代码依赖它）。
+- 安装命令统一写 `pip install textgrocery-shop`，代码示例统一写
+  `from tgrocery import Grocery`。
+- 版本号两处必须一致：`pyproject.toml` 的 `[project].version` 与
+  `tgrocery/__init__.py` 的 `__version__`。
+
+## 许可证
+
+`pyproject.toml`、`README.md`、`LICENSE.txt` 统一为 BSD-3-Clause。
+注意：上游 `2shou/TextGrocery` 仓库的 LICENSE.txt 是 GPLv3；若以后直接复制
+上游代码，必须重新评估许可证兼容性。
+
+## 常用命令
+
+```bash
+python3 -m pytest -q
+ruff check .
+ruff format --check .
+rm -rf build dist *.egg-info
+python3 -m build
+python3 -m twine check dist/*
+```
+
+构建要求 `setuptools>=77`（PEP 639 的 `license` / `license-files`）。
+系统自带旧版 setuptools 时不要用 `python3 -m build --no-isolation`。
+
+## 发布
+
+发布使用 `.github/workflows/pypi_publish.yml`：在 GitHub 发布 Release 时，
+通过 PyPI Trusted Publishing 自动上传，不需要仓库保存 token。
+完整流程（版本同步、tag、Release、验证）见两份 README 的
+“打包与发布 / Packaging and publishing”章节。

textgrocery_shop-0.2.0/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, TextGrocery_Shop contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

textgrocery_shop-0.2.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include README_EN.md
+include AGENTS.md
+include LICENSE.txt
+include pyproject.toml
+include benchmark.py
+
+recursive-include tests *.py
+recursive-include sample *.py