ofdkit 0.1.0__tar.gz

ofdkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

ofdkit-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: ofdkit
+Version: 0.1.0
+Summary: Read OFD documents (GB/T 33190) and Chinese e-invoices: text, invoice fields, and AI tool integrations.
+Keywords: ofd,gb/t 33190,e-invoice,fapiao,电子发票,数电票,mcp
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Text Processing
+Requires-Dist: markitdown>=0.1,<0.2 ; extra == 'markitdown'
+Requires-Dist: mcp>=2.3,<3 ; extra == 'mcp'
+Maintainer: Edgar-311
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/Edgar-311/ofdkit
+Project-URL: Issues, https://github.com/Edgar-311/ofdkit/issues
+Project-URL: Changelog, https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md
+Provides-Extra: markitdown
+Provides-Extra: mcp
+Description-Content-Type: text/markdown
+
+# ofdkit
+
+轻量的 Python 工具，用来读取 OFD 文件，提取里面的文字和发票字段，并能接入 AI 工具。OFD 是中国的国家标准版式文档格式（GB/T 33190），常见于电子发票和公文。
+
+A lightweight Python toolkit for reading OFD documents (GB/T 33190, the Chinese fixed-layout format used for e-invoices and official documents): extract text and invoice fields, and use them from AI tools.
+
+> 状态：0.1 版，接口以后可能还会调整。更新记录见 [CHANGELOG](https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md)。
+> Status: 0.1, the API may still change. See the [CHANGELOG](https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md).
+
+## 能做什么 / What it does
+
+- 按阅读顺序提取文字，包括模板和复合对象里的文字。
+  Text in reading order, including text in templates and composite objects.
+- 读取电子发票字段（数电票和增值税电子发票），输出 JSON：发票号码、开票日期、购买方、销售方、金额、税额、价税合计、明细。
+  Invoice fields from e-invoices as JSON: number, date, buyer, seller, amounts, tax, total, line items.
+- 把一个文件夹里的发票汇总成 CSV，Excel 可以直接打开，并提示重复的发票号码。
+  A folder of invoices summarised as CSV (opens in Excel), with duplicate invoice numbers flagged.
+- 只用 Python 标准库，没有任何第三方依赖；能读很多不规范的文件（路径写法不对、编码不对、XML 前缀错误等）。
+  Standard library only, no dependencies; reads many non-conforming files (bad paths, encodings, XML prefixes).
+
+## 安装 / Install
+
+需要 Python 3.10 或更新版本。Requires Python 3.10+.
+
+```bash
+pip install ofdkit
+```
+
+## 命令行 / Command line
+
+```bash
+ofdkit text 文件.ofd                         # 提取文字 / print text
+ofdkit invoice 发票.ofd                      # 发票字段（JSON）/ invoice fields as JSON
+ofdkit batch 发票文件夹/ -o 发票汇总.csv      # 批量汇总 / summarise a folder as CSV
+ofdkit info 文件.ofd                         # 页数、作者等信息 / pages and metadata
+```
+
+`ofdkit invoice` 的输出示例（数据是虚构的）/ Example output (fictional data):
+
+```json
+{
+  "invoice_number": "00000000000000000001",
+  "invoice_code": null,
+  "issue_date": "2026-01-02",
+  "check_code": null,
+  "machine_number": null,
+  "buyer": {"name": "测试单位甲", "tax_id": "TESTBUYER0001", "address_phone": null, "bank_account": null},
+  "seller": {"name": "测试单位乙", "tax_id": "TESTSELLER0002", "address_phone": null, "bank_account": null},
+  "amount_without_tax": "100.00",
+  "tax_amount": "6.00",
+  "total_amount": "106.00",
+  "issuer": "测试人员",
+  "payee": null,
+  "reviewer": null,
+  "note": null,
+  "items": [
+    {"name": "*测试*服务项目", "specification": null, "unit": null, "quantity": null,
+     "unit_price": null, "amount": "100.00", "tax_rate": "6%", "tax_amount": "6.00"}
+  ],
+  "sources": ["custom_tags"],
+  "warnings": []
+}
+```
+
+金额是字符串，不会丢失精度。如果"合计金额 + 合计税额"不等于"价税合计"，`warnings` 里会提示。
+Amounts are decimal strings, so no precision is lost. `warnings` notes totals that do not add up.
+
+## 在 AI 工具里使用 / Use from AI tools
+
+### MCP 服务器 / MCP server
+
+让 Claude、Codex、Cursor 等 AI 工具直接读取 OFD 文件。需要先安装 [uv](https://docs.astral.sh/uv/)。所有工具都是只读的。
+Lets Claude, Codex, Cursor and other AI tools read OFD files. Requires [uv](https://docs.astral.sh/uv/). All tools are read-only.
+
+| 工具 / Tool | 作用 / What it does |
+| --- | --- |
+| `read_ofd_text` | 按阅读顺序提取文字，可选 Markdown 和页码范围 / text in reading order, optional Markdown and page range |
+| `read_ofd_invoice` | 发票字段 / invoice fields |
+| `ofd_info` | 页数、尺寸、元数据 / pages, sizes, metadata |
+| `list_ofd_invoices` | 汇总一个文件夹里的发票 / summarise a folder of invoices |
+
+Claude Code:
+
+```bash
+claude mcp add ofdkit -- uvx --from "ofdkit[mcp]" ofdkit mcp
+```
+
+Claude Desktop、Cursor 等使用 JSON 配置的工具 / tools with a JSON config:
+
+```json
+{
+  "mcpServers": {
+    "ofdkit": {
+      "command": "uvx",
+      "args": ["--from", "ofdkit[mcp]", "ofdkit", "mcp"]
+    }
+  }
+}
+```
+
+Codex（`~/.codex/config.toml`）:
+
+```toml
+[mcp_servers.ofdkit]
+command = "uvx"
+args = ["--from", "ofdkit[mcp]", "ofdkit", "mcp"]
+```
+
+加上 `--root 文件夹` 可以只允许读取这个文件夹里的文件。
+Add `--root FOLDER` to allow only files inside that folder.
+
+### Agent Skill
+
+[`skills/ofd-reader`](https://github.com/Edgar-311/ofdkit/tree/main/skills/ofd-reader) 告诉 AI 什么时候、怎么用 ofdkit 命令行，适用于支持 [Agent Skills](https://agentskills.io) 的工具。把这个文件夹复制到：
+[`skills/ofd-reader`](https://github.com/Edgar-311/ofdkit/tree/main/skills/ofd-reader) tells an AI agent when and how to use the ofdkit command line. Copy the folder to:
+
+- Claude Code: `~/.claude/skills/ofd-reader/`
+- Codex: `~/.codex/skills/ofd-reader/`
+
+### MarkItDown 插件 / MarkItDown plugin
+
+[MarkItDown](https://github.com/microsoft/markitdown) 是把各种文件转成 Markdown 给 AI 读的工具。安装插件后它就能读 OFD：
+[MarkItDown](https://github.com/microsoft/markitdown) converts files to Markdown for AI. With this plugin it reads OFD too:
+
+```bash
+pip install "ofdkit[markitdown]"
+markitdown --use-plugins 发票.ofd
+```
+
+## Python
+
+```python
+import ofdkit
+
+with ofdkit.open("发票.ofd") as doc:
+    print(doc.text())
+    invoice = doc.invoice()        # 不是发票时返回 None / None if not an invoice
+    if invoice:
+        print(invoice.invoice_number, invoice.total_amount)
+```
+
+## 注意 / Notes
+
+- ofdkit 只读取文件里写了什么，不验证发票真伪。查验真伪请使用国家税务总局的发票查验平台。
+  ofdkit reports what a file contains. It does not verify that an invoice is genuine.
+- 文字如果是画成图形或图片的，就读不出来（需要 OCR，不在本项目范围内）。
+  Text drawn as shapes or images cannot be extracted (that needs OCR, which is out of scope).
+- 多栏排版的页面，目前两栏的文字会出现在同一行，用三个空格隔开。
+  On multi-column pages, both columns currently share each line, separated by three spaces.
+
+## 原则 / Principles
+
+- 只读取 OFD，不生成、不修改发票。
+  Reads OFD only. It never creates or modifies invoices.
+- 本项目大部分代码由 AI（Claude）编写，维护者负责决定方向和批准发布。
+  Most code is written with AI assistance (Claude). The maintainer sets the direction and approves releases.
+
+## 许可证 / License
+
+[Apache-2.0](https://github.com/Edgar-311/ofdkit/blob/main/LICENSE)

ofdkit-0.1.0/README.md

@@ -0,0 +1,160 @@
+# ofdkit
+
+轻量的 Python 工具，用来读取 OFD 文件，提取里面的文字和发票字段，并能接入 AI 工具。OFD 是中国的国家标准版式文档格式（GB/T 33190），常见于电子发票和公文。
+
+A lightweight Python toolkit for reading OFD documents (GB/T 33190, the Chinese fixed-layout format used for e-invoices and official documents): extract text and invoice fields, and use them from AI tools.
+
+> 状态：0.1 版，接口以后可能还会调整。更新记录见 [CHANGELOG](https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md)。
+> Status: 0.1, the API may still change. See the [CHANGELOG](https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md).
+
+## 能做什么 / What it does
+
+- 按阅读顺序提取文字，包括模板和复合对象里的文字。
+  Text in reading order, including text in templates and composite objects.
+- 读取电子发票字段（数电票和增值税电子发票），输出 JSON：发票号码、开票日期、购买方、销售方、金额、税额、价税合计、明细。
+  Invoice fields from e-invoices as JSON: number, date, buyer, seller, amounts, tax, total, line items.
+- 把一个文件夹里的发票汇总成 CSV，Excel 可以直接打开，并提示重复的发票号码。
+  A folder of invoices summarised as CSV (opens in Excel), with duplicate invoice numbers flagged.
+- 只用 Python 标准库，没有任何第三方依赖；能读很多不规范的文件（路径写法不对、编码不对、XML 前缀错误等）。
+  Standard library only, no dependencies; reads many non-conforming files (bad paths, encodings, XML prefixes).
+
+## 安装 / Install
+
+需要 Python 3.10 或更新版本。Requires Python 3.10+.
+
+```bash
+pip install ofdkit
+```
+
+## 命令行 / Command line
+
+```bash
+ofdkit text 文件.ofd                         # 提取文字 / print text
+ofdkit invoice 发票.ofd                      # 发票字段（JSON）/ invoice fields as JSON
+ofdkit batch 发票文件夹/ -o 发票汇总.csv      # 批量汇总 / summarise a folder as CSV
+ofdkit info 文件.ofd                         # 页数、作者等信息 / pages and metadata
+```
+
+`ofdkit invoice` 的输出示例（数据是虚构的）/ Example output (fictional data):
+
+```json
+{
+  "invoice_number": "00000000000000000001",
+  "invoice_code": null,
+  "issue_date": "2026-01-02",
+  "check_code": null,
+  "machine_number": null,
+  "buyer": {"name": "测试单位甲", "tax_id": "TESTBUYER0001", "address_phone": null, "bank_account": null},
+  "seller": {"name": "测试单位乙", "tax_id": "TESTSELLER0002", "address_phone": null, "bank_account": null},
+  "amount_without_tax": "100.00",
+  "tax_amount": "6.00",
+  "total_amount": "106.00",
+  "issuer": "测试人员",
+  "payee": null,
+  "reviewer": null,
+  "note": null,
+  "items": [
+    {"name": "*测试*服务项目", "specification": null, "unit": null, "quantity": null,
+     "unit_price": null, "amount": "100.00", "tax_rate": "6%", "tax_amount": "6.00"}
+  ],
+  "sources": ["custom_tags"],
+  "warnings": []
+}
+```
+
+金额是字符串，不会丢失精度。如果"合计金额 + 合计税额"不等于"价税合计"，`warnings` 里会提示。
+Amounts are decimal strings, so no precision is lost. `warnings` notes totals that do not add up.
+
+## 在 AI 工具里使用 / Use from AI tools
+
+### MCP 服务器 / MCP server
+
+让 Claude、Codex、Cursor 等 AI 工具直接读取 OFD 文件。需要先安装 [uv](https://docs.astral.sh/uv/)。所有工具都是只读的。
+Lets Claude, Codex, Cursor and other AI tools read OFD files. Requires [uv](https://docs.astral.sh/uv/). All tools are read-only.
+
+| 工具 / Tool | 作用 / What it does |
+| --- | --- |
+| `read_ofd_text` | 按阅读顺序提取文字，可选 Markdown 和页码范围 / text in reading order, optional Markdown and page range |
+| `read_ofd_invoice` | 发票字段 / invoice fields |
+| `ofd_info` | 页数、尺寸、元数据 / pages, sizes, metadata |
+| `list_ofd_invoices` | 汇总一个文件夹里的发票 / summarise a folder of invoices |
+
+Claude Code:
+
+```bash
+claude mcp add ofdkit -- uvx --from "ofdkit[mcp]" ofdkit mcp
+```
+
+Claude Desktop、Cursor 等使用 JSON 配置的工具 / tools with a JSON config:
+
+```json
+{
+  "mcpServers": {
+    "ofdkit": {
+      "command": "uvx",
+      "args": ["--from", "ofdkit[mcp]", "ofdkit", "mcp"]
+    }
+  }
+}
+```
+
+Codex（`~/.codex/config.toml`）:
+
+```toml
+[mcp_servers.ofdkit]
+command = "uvx"
+args = ["--from", "ofdkit[mcp]", "ofdkit", "mcp"]
+```
+
+加上 `--root 文件夹` 可以只允许读取这个文件夹里的文件。
+Add `--root FOLDER` to allow only files inside that folder.
+
+### Agent Skill
+
+[`skills/ofd-reader`](https://github.com/Edgar-311/ofdkit/tree/main/skills/ofd-reader) 告诉 AI 什么时候、怎么用 ofdkit 命令行，适用于支持 [Agent Skills](https://agentskills.io) 的工具。把这个文件夹复制到：
+[`skills/ofd-reader`](https://github.com/Edgar-311/ofdkit/tree/main/skills/ofd-reader) tells an AI agent when and how to use the ofdkit command line. Copy the folder to:
+
+- Claude Code: `~/.claude/skills/ofd-reader/`
+- Codex: `~/.codex/skills/ofd-reader/`
+
+### MarkItDown 插件 / MarkItDown plugin
+
+[MarkItDown](https://github.com/microsoft/markitdown) 是把各种文件转成 Markdown 给 AI 读的工具。安装插件后它就能读 OFD：
+[MarkItDown](https://github.com/microsoft/markitdown) converts files to Markdown for AI. With this plugin it reads OFD too:
+
+```bash
+pip install "ofdkit[markitdown]"
+markitdown --use-plugins 发票.ofd
+```
+
+## Python
+
+```python
+import ofdkit
+
+with ofdkit.open("发票.ofd") as doc:
+    print(doc.text())
+    invoice = doc.invoice()        # 不是发票时返回 None / None if not an invoice
+    if invoice:
+        print(invoice.invoice_number, invoice.total_amount)
+```
+
+## 注意 / Notes
+
+- ofdkit 只读取文件里写了什么，不验证发票真伪。查验真伪请使用国家税务总局的发票查验平台。
+  ofdkit reports what a file contains. It does not verify that an invoice is genuine.
+- 文字如果是画成图形或图片的，就读不出来（需要 OCR，不在本项目范围内）。
+  Text drawn as shapes or images cannot be extracted (that needs OCR, which is out of scope).
+- 多栏排版的页面，目前两栏的文字会出现在同一行，用三个空格隔开。
+  On multi-column pages, both columns currently share each line, separated by three spaces.
+
+## 原则 / Principles
+
+- 只读取 OFD，不生成、不修改发票。
+  Reads OFD only. It never creates or modifies invoices.
+- 本项目大部分代码由 AI（Claude）编写，维护者负责决定方向和批准发布。
+  Most code is written with AI assistance (Claude). The maintainer sets the direction and approves releases.
+
+## 许可证 / License
+
+[Apache-2.0](https://github.com/Edgar-311/ofdkit/blob/main/LICENSE)

ofdkit-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["uv_build>=0.11.32,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "ofdkit"
+version = "0.1.0"
+description = "Read OFD documents (GB/T 33190) and Chinese e-invoices: text, invoice fields, and AI tool integrations."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+maintainers = [{ name = "Edgar-311" }]
+keywords = ["ofd", "gb/t 33190", "e-invoice", "fapiao", "电子发票", "数电票", "mcp"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: Chinese (Simplified)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Text Processing",
+]
+dependencies = []
+
+[project.optional-dependencies]
+markitdown = ["markitdown>=0.1,<0.2"]
+mcp = ["mcp>=2.3,<3"]
+
+[project.scripts]
+ofdkit = "ofdkit.cli:main"
+
+[project.entry-points."markitdown.plugin"]
+ofdkit = "ofdkit.markitdown_plugin"
+
+[project.urls]
+Homepage = "https://github.com/Edgar-311/ofdkit"
+Issues = "https://github.com/Edgar-311/ofdkit/issues"
+Changelog = "https://github.com/Edgar-311/ofdkit/blob/main/CHANGELOG.md"

ofdkit-0.1.0/src/ofdkit/__init__.py

@@ -0,0 +1,54 @@
+"""ofdkit: read OFD documents (GB/T 33190) and Chinese e-invoices.
+
+>>> import ofdkit
+>>> with ofdkit.open("invoice.ofd") as doc:  # doctest: +SKIP
+...     print(doc.text())
+...     print(doc.invoice())
+"""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as _version
+
+from .document import DocInfo, OFDDocument, Page, TextRun
+from .errors import OFDError, OFDFormatError, OFDLimitError
+from .invoice import Invoice, LineItem, Party
+from .package import Source
+
+try:
+    __version__ = _version("ofdkit")
+except PackageNotFoundError:  # running from a source checkout that is not installed
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "DocInfo",
+    "Invoice",
+    "LineItem",
+    "OFDDocument",
+    "OFDError",
+    "OFDFormatError",
+    "OFDLimitError",
+    "Page",
+    "Party",
+    "TextRun",
+    "__version__",
+    "extract_invoice",
+    "extract_text",
+    "open",
+]
+
+
+def open(source: Source) -> OFDDocument:  # noqa: A001 - mirrors builtins.open on purpose
+    """Open an OFD file from a path, bytes, or a binary file object."""
+    return OFDDocument(source)
+
+
+def extract_text(source: Source, page_separator: str = "\n\n") -> str:
+    """Return all text of an OFD file in reading order."""
+    with OFDDocument(source) as document:
+        return document.text(page_separator)
+
+
+def extract_invoice(source: Source) -> Invoice | None:
+    """Return the invoice data of an OFD e-invoice, or None if the file holds none."""
+    with OFDDocument(source) as document:
+        return document.invoice()

ofdkit-0.1.0/src/ofdkit/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())