betteroffice-docx 0.0.1__tar.gz

betteroffice_docx-0.0.1/Cargo.toml

@@ -0,0 +1,53 @@
+[workspace]
+members = ["crates/*"]
+resolver = "3"
+
+[workspace.package]
+version = "0.0.4"
+edition = "2024"
+license = "Apache-2.0"
+homepage = "https://betteroffice.dev"
+repository = "https://github.com/openooxml/betteroffice"
+
+[workspace.dependencies]
+betteroffice-xlsx = { path = "crates/betteroffice-xlsx", version = "0.0.4", default-features = false }
+ooxml-opc = { package = "betteroffice-opc", path = "crates/ooxml-opc", version = "0.0.4" }
+xlsx-model = { package = "betteroffice-xlsx-model", path = "crates/xlsx-model", version = "0.0.4" }
+xlsx-parse = { package = "betteroffice-xlsx-parse", path = "crates/xlsx-parse", version = "0.0.4" }
+xlsx-calc = { package = "betteroffice-xlsx-calc", path = "crates/xlsx-calc", version = "0.0.4" }
+xlsx-ops = { package = "betteroffice-xlsx-ops", path = "crates/xlsx-ops", version = "0.0.4" }
+xlsx-render = { package = "betteroffice-xlsx-render", path = "crates/xlsx-render", version = "0.0.4" }
+xlsx-raster = { package = "betteroffice-xlsx-raster", path = "crates/xlsx-raster", version = "0.0.4" }
+ooxml-text = { package = "betteroffice-ooxml-text", path = "crates/ooxml-text", version = "0.0.4" }
+ooxml-drawingml = { package = "betteroffice-drawingml", path = "crates/ooxml-drawingml", version = "0.0.4" }
+docx-parse = { package = "betteroffice-docx-parse", path = "crates/docx-parse", version = "0.0.4" }
+docx-layout = { package = "betteroffice-docx-layout", path = "crates/docx-layout", version = "0.0.4" }
+docx-raster = { package = "betteroffice-docx-raster", path = "crates/docx-raster", version = "0.0.4" }
+docx-edit = { package = "betteroffice-docx-edit", path = "crates/docx-edit", version = "0.0.4" }
+betteroffice-docx = { path = "crates/betteroffice-docx", version = "0.0.4" }
+pptx-parse = { package = "betteroffice-pptx-parse", path = "crates/pptx-parse", version = "0.0.4" }
+pptx-edit = { package = "betteroffice-pptx-edit", path = "crates/pptx-edit", version = "0.0.4" }
+pptx-render = { package = "betteroffice-pptx-render", path = "crates/pptx-render", version = "0.0.4" }
+betteroffice-pptx = { path = "crates/betteroffice-pptx", version = "0.0.4" }
+
+[profile.release]
+opt-level = "s"
+lto = true
+
+[profile.release.package.betteroffice-docx-layout]
+opt-level = 3
+
+[profile.release.package.betteroffice-docx-parse]
+opt-level = 3
+
+# The per-keystroke hot path lives in docx-edit (engine session, frame
+# encoding), ooxml-text (shaping/measurement), and yrs (text CRDT ops); the
+# size-optimized workspace default measurably slows all three.
+[profile.release.package.betteroffice-docx-edit]
+opt-level = 3
+
+[profile.release.package.betteroffice-ooxml-text]
+opt-level = 3
+
+[profile.release.package.yrs]
+opt-level = 3

betteroffice_docx-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Elia Hilse, The OpenOOXML Project
+
+   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.

betteroffice_docx-0.0.1/NOTICE

@@ -0,0 +1,2 @@
+BetterOffice
+Copyright 2026 Elia Hilse, The OpenOOXML Project

betteroffice_docx-0.0.1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: betteroffice-docx
+Version: 0.0.1
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: Rust
+Classifier: Topic :: Office/Business :: Office Suites
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD-PARTY-NOTICES.md
+Summary: Read, edit, lay out, and render DOCX documents. Rust engine, no Word and no LibreOffice.
+Keywords: docx,word,document,ooxml,wordprocessingml,layout,pagination,python-docx,rust
+Home-Page: https://betteroffice.dev
+Author: OpenOOXML
+License-Expression: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/openooxml/betteroffice/blob/main/bindings/python-docx/CHANGELOG.md
+Project-URL: Documentation, https://docs.betteroffice.dev/docs/python
+Project-URL: Homepage, https://betteroffice.dev
+Project-URL: Issues, https://github.com/openooxml/betteroffice/issues
+Project-URL: Source, https://github.com/openooxml/betteroffice
+
+# betteroffice-docx
+
+Read, edit, lay out, and rasterize DOCX documents from Python. `python-docx`
+reads a document and writes one back; this also *paginates* it — page boxes, a
+display list, PNG pages — because the Rust
+[BetterOffice](https://betteroffice.dev) DOCX core is compiled into the wheel:
+no Word, no LibreOffice subprocess, no COM.
+
+```bash
+pip install betteroffice-docx
+```
+
+The distribution is hyphenated, the module is not: `import betteroffice_docx`.
+
+## Read a document
+
+```python
+from betteroffice_docx import Document
+
+document = Document.open_path("report.docx")
+
+print(document.structure())          # Structure(body_paragraphs=42, body_tables=3, sections=2)
+for paragraph in document:
+    print(paragraph.id, paragraph.style, repr(paragraph.text))
+
+for table in document.tables():
+    for row in table.rows:
+        print([cell.text for cell in row.cells])
+```
+
+`paragraphs()` walks the body in document order and descends into table cells
+and content controls, so a cell paragraph is reachable both ways.
+`document[key]` and `document.paragraph(key)` take either a `w14:paraId` or a
+body index. Everything a read returns is a value, not a live view — read again
+after an edit.
+
+Page geometry is in twips — 1440 to the inch. The module exports
+`TWIPS_PER_INCH` and `TWIPS_PER_POINT`.
+
+```python
+section = document.sections()[0]
+print(section.page_width, section.page_height, section.margin_left)
+print(document.headers()[0].text)
+```
+
+## Edit text
+
+```python
+edit = document.replace_text("11111111", "Edited from Python")
+print(edit.para_id, edit.start, edit.end)
+
+document.save_path("report-edited.docx")
+```
+
+`replace_text` rewrites one paragraph and keeps its style, alignment, and the
+run formatting it already had. The engine rebuilds the paragraph from a single
+run, so a paragraph that mixes runs — half bold, a hyperlink, a field — raises
+`UnsupportedEditError` rather than flattening the formatting you did not ask it
+to touch. An unknown `w14:paraId` raises `KeyError`.
+
+Only paragraphs Word stamped with a `w14:paraId` can be addressed:
+`document.paragraph_ids` reports `None` for the rest.
+
+## Write
+
+Unlike the PPTX binding, edits reach the file: `save()` serializes the edited
+model, and reopening the result gives the edited text back.
+
+```python
+document = Document.open(data)
+document.replace_text(document.paragraph_ids[0], "New first line")
+reopened = Document.open(document.save())
+reopened.paragraph(0).text          # 'New first line'
+```
+
+Saving is deterministic. The engine has no clock, so timestamps come from
+`document.timestamp` — the epoch until you set one — and the same input plus the
+same edits produce the same bytes. `save(now=..., update_modified_date=True,
+modified_by=...)` overrides that for one call.
+
+The container is rebuilt rather than patched, so output is not byte-identical to
+the source even with no edits; the parts the model retained survive unchanged.
+
+## Lay a document out
+
+Layout is a two-stage contract. Something else measures text — the browser, or
+`ooxml-text` — and the engine paginates the measured blocks and compiles them
+into a display list:
+
+```python
+layout = document.layout({"measured": measured_blocks, "options": {...}})
+print(len(layout), layout.pages)
+layout.write("layout.json")
+
+pages = layout.display_list
+print(len(pages), pages.primitives)
+```
+
+`layout()` takes the envelope as a `dict` or as a JSON string, and returns the
+page boxes (`layout.json`, `layout.to_dict()`) beside the display list that
+paints them.
+
+## Rasterize
+
+**No font is compiled into the wheel**, so a page with text needs at least one
+registered face:
+
+```python
+from pathlib import Path
+
+document.register_font("Carlito", Path("Carlito-Regular.ttf").read_bytes())
+document.register_font("Carlito", Path("Carlito-Bold.ttf").read_bytes(), bold=True)
+
+png = document.render_png(layout.display_list, 0)
+png.write("page-0.png")
+print(len(png), png.skipped_images)
+```
+
+Text whose family has no chain raises `RenderError` naming the chain it wanted
+— ``missing font chain for `calibri|0|0` `` — so a missing face is loud rather
+than silently blank.
+
+Images are the opposite: an image reference the backend cannot resolve is
+skipped and counted in `png.skipped_images` instead of failing the page. Word
+hands out relationship ids per part, so `rId9` in the body and `rId9` in a
+header are different images and registration is scoped:
+
+```python
+document.register_image("rId9", body_png)
+document.register_image("rId9", header_png, scope="header_footer", part="rId7")
+document.register_image("rId4", note_png, scope="footnotes")
+```
+
+Images the display list already carries as `data:` URLs need no registration.
+A page past `MAX_PIXMAP_DIM` per side or `MAX_PIXMAP_PIXELS` in area is refused
+before any surface is allocated.
+
+## Compared with python-docx
+
+| | `python-docx` | `betteroffice-docx` |
+| --- | --- | --- |
+| Read paragraphs, tables, sections | yes | yes |
+| Write text back to a file | yes | yes, single-run paragraphs |
+| Build a document from scratch | yes | no — it edits what you open |
+| Paginate (page boxes, display list) | no | yes |
+| Rasterize pages to PNG | no | yes |
+| Engine | pure Python | Rust, compiled |
+
+`python-docx` is a far broader authoring library. If what you need is
+pagination, page images, or an engine that reads what Word actually wrote, that
+is the gap this fills.
+
+## API
+
+| | |
+| --- | --- |
+| `Document.open(data)` / `open_path(path)` | open from bytes or a path |
+| `document.structure()` | paragraph, table, section, and note counts |
+| `document.paragraphs()` / `tables()` / `sections()` | body content |
+| `document.headers()` / `footers()` | header and footer stories |
+| `document[key]` / `document.paragraph(key)` | one paragraph by ID or index |
+| `document.paragraph_ids` / `text` | body IDs, and the whole text |
+| `document.warnings` / `template_variables` | what the parser found |
+| `document.replace_text(para_id, text)` | rewrite one paragraph |
+| `document.author` / `origin` / `timestamp` | how an edit is attributed and stamped |
+| `document.layout(input)` | paginate a measured envelope |
+| `document.register_font` / `register_image` | raster resources |
+| `document.render_png(display_list, page)` | rasterize one page |
+| `document.save()` / `save_path(path)` | serialize to DOCX |
+
+Errors raise `DocxError` or a more specific subclass: `ParseError`,
+`EditError`, `UnsupportedEditError`, `LayoutError`, `RenderError`. An unknown
+paragraph ID raises `KeyError`, an out-of-range index `IndexError`, and a bad
+argument — an unknown parse limit, an unknown image scope, malformed font bytes
+— `ValueError`.
+
+Parser bounds can be tightened for untrusted input:
+
+```python
+Document.open(untrusted, limits={"max_paragraphs": 5_000, "max_tables": 500})
+```
+
+An unknown limit name raises `ValueError` rather than being ignored.
+
+## Threads
+
+A `Document` is not pinned to a thread: the engine's document type is `Send` and
+`Sync`, so opening on one thread and dropping on another is fine. Parsing,
+layout, rasterization, and saving release the GIL for their duration, so several
+documents genuinely proceed in parallel.
+
+## Status
+
+`0.0.x`, and the API may change before `0.1.0`. Editing covers paragraph text on
+plain single-run paragraphs; richer edits land on the Rust facade first.
+
+Wheels are built for Linux (x86_64, aarch64), macOS (arm64, x86_64), and Windows
+(x86_64) against the stable ABI for CPython 3.9 and up.
+
+## Links
+
+- [BetterOffice](https://betteroffice.dev) — the project
+- [Documentation](https://docs.betteroffice.dev/docs/python)
+- [Source](https://github.com/openooxml/betteroffice) — `bindings/python-docx`
+- [betteroffice-docx on crates.io](https://crates.io/crates/betteroffice-docx) — the engine this wraps
+
+Apache-2.0.
+