carbotek 0.1.0__tar.gz

carbotek-0.1.0/LICENSE

@@ -0,0 +1,75 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.
+
+Required Notice: Copyright (c) 2026 Carbotek

carbotek-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+carbotek
+Copyright (c) 2026 Carbotek
+
+Licensed under the PolyForm Noncommercial License 1.0.0 (see LICENSE).
+Commercial use requires a separate license from the copyright holder.
+
+This product is derived from Carbone v3.2.3
+(https://github.com/carboneio/carbone),
+Copyright (c) CarboneIO SAS and contributors,
+licensed under the Apache License, Version 2.0 (see licenses/Carbone-Apache-2.0.txt).
+The original JavaScript code was translated to Python and Rust and substantially modified.
+
+carbotek is not affiliated with or endorsed by CarboneIO SAS.

carbotek-0.1.0/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.4
+Name: carbotek
+Version: 0.1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Office/Business :: Office Suites
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: Typing :: Typed
+Requires-Dist: dxpdf>=0.8,<1
+Requires-Dist: lxml>=5.3,<7
+Requires-Dist: pillow>=11,<13
+Requires-Dist: python-barcode>=0.16,<1
+Requires-Dist: resvg-py>=0.5,<0.6
+Requires-Dist: segno>=1.6,<2
+Requires-Dist: tzdata>=2025.2
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_LICENSES.md
+License-File: licenses/Carbone-Apache-2.0.txt
+License-File: licenses/Unicode-3.0.txt
+License-File: licenses/dayjs-MIT.txt
+Summary: Render DOCX/XLSX templates with Carbone-style markers to DOCX, XLSX or PDF, without LibreOffice
+Keywords: docx,xlsx,pdf,template,report,carbone,document-generation
+Author-email: Carbotek <337455888+carbotek@users.noreply.github.com>
+License-Expression: PolyForm-Noncommercial-1.0.0
+Requires-Python: >=3.15
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/carbotek/carbotek
+Project-URL: Issues, https://github.com/carbotek/carbotek/issues
+
+# carbotek
+
+<p align="center">
+  <a href="https://github.com/carbotek/carbotek/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/carbotek/carbotek/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/carbotek/"><img alt="PyPI" src="https://img.shields.io/pypi/v/carbotek?color=blue"></a>
+  <img alt="Python" src="https://img.shields.io/badge/python-3.15%2B-3776AB?logo=python&logoColor=white">
+  <img alt="Rust" src="https://img.shields.io/badge/native-Rust%201.99-CE422B?logo=rust&logoColor=white">
+  <a href="https://github.com/carbotek/carbotek/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-PolyForm%20Noncommercial%201.0.0-orange"></a>
+  <br>
+  <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
+  <a href="https://github.com/astral-sh/uv"><img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json"></a>
+  <a href="https://microsoft.github.io/pyright/"><img alt="Checked with pyright" src="https://microsoft.github.io/pyright/img/pyright_badge.svg"></a>
+  <a href="https://docs.gauge.sh"><img alt="Architecture: tach" src="https://img.shields.io/badge/architecture-tach-6C47FF"></a>
+  <img alt="Typed" src="https://img.shields.io/badge/typing-typed-brightgreen">
+  <img alt="Carbone syntax" src="https://img.shields.io/badge/Carbone%20syntax-5.14.4-2E7D32">
+</p>
+
+**English** | [Русский](https://github.com/carbotek/carbotek/blob/main/README.ru.md)
+
+Render DOCX and XLSX templates with Carbone-style markers (`{d.name}`, loops, conditions,
+formatters, images, barcodes, HTML, hyperlinks, colors) into DOCX, XLSX or PDF from Python.
+There is no LibreOffice: PDF is produced by [`dxpdf`](https://pypi.org/project/dxpdf/).
+
+carbotek is a Python port of the DOCX and XLSX engine of [Carbone](https://github.com/carboneio/carbone)
+**v3.2.3**, the last Carbone release under the Apache License 2.0. The template syntax is compatible
+with Carbone **5.14.4**. Behaviour was checked against the JavaScript engine with a differential
+corpus and formatter oracles.
+
+carbotek is an independent project and is not affiliated with or endorsed by CarboneIO SAS.
+"Carbone" is used only to describe compatibility.
+
+> Licensed under the **PolyForm Noncommercial 1.0.0** license. It is free for noncommercial
+> use; commercial use requires a separate license (see [LICENSE](https://github.com/carbotek/carbotek/blob/main/LICENSE)).
+
+## Installation
+
+```bash
+pip install carbotek        # or: uv add carbotek
+```
+
+Requires CPython 3.15+. The primary target is Linux in Docker (`python:3.15-slim-trixie`); CI runs
+the test suite against the released wheel inside that image.
+
+Linux wheels (manylinux, x86_64 and aarch64, one abi3 wheel for CPython 3.15+) contain an optional native accelerator (`carbotek._native`, Rust) that renders common
+loop tables and money formatting faster; the output is identical to the pure-Python path. A
+source-distribution install builds the accelerator and needs a Rust toolchain (1.87+). Set `CARBOTEK_NATIVE=0` to render without it, or `CARBOTEK_NATIVE=1` to make a
+missing extension an import error; the variable is read once, when `carbotek` is imported.
+
+A universal `py3-none-any` wheel is also published for environments without Rust. Pip prefers
+an available platform wheel; select the universal wheel explicitly to install only the Python
+renderer. From an unpacked source distribution, build it with
+`uv run --no-project --with build --with setuptools --with wheel python tools/build_pure_wheel.py --out dist`.
+
+## Library
+
+```python
+import json
+import carbotek
+
+template = open("invoice.docx", "rb").read()
+data = json.load(open("data.json", encoding="utf-8"))
+
+docx = carbotek.render(template, data, {"lang": "en", "timezone": "Europe/London"})
+pdf = carbotek.render_pdf(template, data, image_dpi=220)   # DOCX templates only
+
+engine = carbotek.Engine(cache_size=16)   # own compiled-template cache
+engine.render(template, data)
+print(engine.metrics)                     # size, bytes, hits, misses, hit_rate
+```
+
+`carbotek.render` detects the template type: a DOCX template returns DOCX, an XLSX template
+returns XLSX. The module-level functions share one default `Engine`.
+
+### Options
+
+Options are the keys of `RenderOptions.create`:
+
+| Key | Meaning |
+|---|---|
+| `lang` | Document language (default `ru`) |
+| `timezone` | IANA time zone (default `Europe/Moscow`) |
+| `complement` | `{c.*}` data |
+| `translations` | `{t(...)}` dictionaries |
+| `enum` | Enumerations for `convEnum` |
+| `currency` | `{"source", "target", "rates"}` |
+| `variable_str` | Template variables |
+| `use_high_precision_arithmetic` | High-precision arithmetic |
+| `export_formatted_values_as_text` | XLSX: keep formatted numbers as text |
+
+### Russian formatters
+
+carbotek adds formatters for Russian business documents (they are not part of Carbone):
+
+| Formatter (aliases) | Example | Result |
+|---|---|---|
+| `digitCurrency` (`numCurrency`, `numberCurrency`, `digitalCurrency`) | `{d.a:digitCurrency}`, a = 1234567.5 | `1 234 567,50` |
+| | `{d.a:digitCurrency(0)}` | `1 234 568` |
+| `formatAmount` | `{d.a:formatAmount}`, a = 1234.5 | `1 234,50` |
+| `wordNumber` (`words`, `numberToWords`) | `{d.a:wordNumber}`, a = 1234 | `одна тысяча двести тридцать четыре` |
+| `wordCurrency` | `{d.a:wordCurrency}`, a = 1234.56 | `Одна тысяча двести тридцать четыре рубля 56 копеек` |
+| `moneyFull` (`sumFull`) | `{d.a:moneyFull}`, a = 1234.56 | `1 234,56 (Одна тысяча двести тридцать четыре рубля 56 копеек)` |
+| `procent` (`percent`) | `{d.a:procent}`, a = 20 | `20,00 %` |
+| `dashIfZero` (`dashZero`) | `{d.a:dashIfZero}`, a = 0 | `—` |
+| `plural` (`pluralize`) | `{d.n:plural('день','дня','дней')}`, n = 5 | `5 дней` |
+| | `{d.n:plural('день','дня','дней', false)}`, n = 21 | `день` |
+| `ruDate` | `{d.dt:ruDate}`, dt = `2026-10-11` | `«11» октября 2026` |
+| `roundHalfUp` | `{d.a:roundHalfUp(1)}`, a = 2.25 | `2.3` |
+| `parseAmount` | `{d.s:parseAmount}`, s = `1 234,50` | `1234.5` |
+| `parseDate` | `{d.s:parseDate}`, s = `11.10.2026` | `2026-10-11` |
+| `capitalize` (`firstUpper`) | `{d.s:capitalize}`, s = `иванов` | `Иванов` |
+
+Amount formatters take an optional precision (default 2) and round half up. `ruDate` uses the
+render time zone, or the one given as an argument.
+
+### Errors
+
+All template and data errors are subclasses of `carbotek.CarbotekError`. Each error has a stable
+`code`:
+
+| Code | Error |
+|---|---|
+| `VALIDATION_ERROR` | Invalid input |
+| `TEMPLATE_ERROR` | Invalid template, marker or formatter |
+| `FEATURE_UNAVAILABLE` | Unsupported feature |
+| `CONVERTER_ERROR` | PDF conversion failed |
+
+Messages follow the JS engine where applicable; input and infrastructure failures have library-specific messages.
+
+### Images from URLs and files
+
+By default, only data URIs are loaded. Remote and local images have to be enabled explicitly:
+
+```python
+from carbotek.features.fetch import ImageSourceConfig
+
+engine = carbotek.Engine(image_sources=ImageSourceConfig(
+    allowlist=("cdn.example.com",),   # hosts allowed for http(s) images; private addresses are refused
+    file_root="/srv/images",          # file:// images are read only under this directory
+    max_bytes=10_485_760,
+    fetch_timeout_ms=5000,
+    max_download_concurrency=4,
+    total_timeout_ms=10000,
+))
+```
+
+Without `image_sources`, the same settings are read from environment variables:
+
+- `CARBOTEK__IMAGE_URL_ALLOWLIST` (comma-separated)
+- `CARBOTEK__IMAGE_FILE_ROOT`
+- `CARBOTEK__IMAGE_MAX_BYTES`
+- `CARBOTEK__IMAGE_FETCH_TIMEOUT_MS`
+- `CARBOTEK__IMAGE_MAX_DOWNLOAD_CONCURRENCY`
+- `CARBOTEK__IMAGE_TOTAL_TIMEOUT_MS`
+
+Environment settings are snapshotted once at the start of each render. Changes during a render affect the next call; an explicit `ImageSourceConfig` takes precedence. Image limits must be positive integers; invalid environment limits raise `ValidationError`. Explicit configuration also validates field types and copies/normalizes the allowlist.
+
+## XLSX
+
+XLSX templates render to XLSX the same way as in Carbone. Supported:
+
+- markers;
+- loops over rows and cells, including nested loops;
+- conditions and conditional blocks;
+- `drop`/`keep` (`row`, `col`, `table`);
+- aggregates and variables.
+
+The workbook is prepared as in the JS engine:
+
+- `calcChain.xml` is removed;
+- shared strings become inline strings;
+- a cell whose only content is a `:formatN` marker becomes numeric. To keep it as text, use the `export_formatted_values_as_text` option or `{o.exportFormattedValuesAsText=true}`.
+
+Markers work anywhere in the workbook: sheet names, headers and footers, defined names, comments.
+
+- **Pictures:** put a marker in the alt text of a sheet picture, for example `{d.logo}` or `{d.code:barcode(ean13)}`.
+- **Hyperlinks:** a hyperlink target `https://d.site` becomes `{d.site:validateURL}`.
+- **Not recalculated:** formulas, `dimension` and merged cells.
+- **No PDF output:** PDF from XLSX raises `FeatureUnavailable`.
+
+## CLI
+
+```bash
+carbotek render template.docx data.json -o out.docx
+carbotek render template.xlsx data.json                    # -> template.out.xlsx
+carbotek render template.docx data.json --pdf -o out.pdf --image-dpi 300
+carbotek bench  template.docx data.json -n 50              # warm cache: cold, mean, p50, p95, min, max, per second
+carbotek bench  template.docx data.json --no-cache --json   # reset module caches and registry for each render
+carbotek markers template.docx                             # markers per part after validated compilation
+```
+
+`python -m carbotek ...` works too.
+
+Common flags:
+
+- `--lang`, `--timezone`;
+- `--options '{"complement": {"company": "X"}}'`;
+- `-` instead of the data file reads data from stdin.
+
+## Using it in a web service / task queue
+
+The API is synchronous and CPU-bound. It takes bytes and returns bytes, and does no I/O except
+the optional image downloads.
+
+- **Create one `Engine` per process** and reuse it, so compiled templates are cached. `Engine` is thread-safe.
+- **Do not call it on the event loop.**
+  - In an async framework, use `await asyncio.to_thread(engine.render, template, data, options)`.
+  - For a task queue (for example taskiq or Celery), a synchronous task with process-based workers scales best, because rendering holds the GIL.
+- **Map `CarbotekError` to client errors (4xx)** by its `code`. Any other exception is a server error.
+- **Install the template fonts in the container** (or metric-compatible fonts such as Carlito/Caladea). PDF uses system fonts.
+
+```python
+import asyncio
+import carbotek
+
+engine = carbotek.Engine(cache_size=64)
+
+async def render_document(template: bytes, data: dict, pdf: bool) -> bytes:
+    if pdf:
+        return await asyncio.to_thread(engine.render_pdf, template, data)
+    return await asyncio.to_thread(engine.render, template, data)
+```
+
+## Limitations
+
+- **ECharts charts are not supported.** A `{d.x:chart}` marker raises `FeatureUnavailable`. Native Word/Excel charts are updated with the data.
+- **PDF has no bookmark outline and no document information** (title, author).
+- **Native OOXML charts are not drawn in PDF.** Their data in the DOCX is still updated.
+- **WMF/EMF images are drawn only partially in PDF.** A warning is logged.
+- **The table of contents is not recalculated.** Page numbers come from the template.
+- **An even/odd-page section break acts like `nextPage`.**
+
+## Differences from Carbone
+
+Deliberate, documented differences from the JavaScript engine:
+
+- A `{o.*}` option split across runs by Word is applied (Carbone leaves it in the text).
+- An object or array printed by a marker uses JavaScript string conversion (`[object Object]`, `1,2`).
+- A named sort combined with a repeater renders (Carbone fails to compile that template).
+- An empty native chart series is written as `ptCount=0`, as OOXML requires.
+- Items without a named sort key keep their input order.
+- Each picture keeps its own frame size when several pictures use the same image marker (Carbone
+  applies the size of the last of them to all).
+- Native wheels are built only for Linux; other platforms install the pure-Python wheel, which is not tested there.
+
+## Development
+
+```bash
+uv sync                      # builds the native extension; needs the Rust toolchain from rust-toolchain.toml
+uv run ruff check . && uv run ruff format --check .
+uv run pyright               # strict mode, per-file headers
+uv run tach check            # layer boundaries, see tach.toml
+uv run pytest -n auto
+```
+
+Layers, from top to bottom: `cli` → `api` → `pipeline`, `opc`, `pdf` → `features`, `xlsx` → `docx`
+→ `markers`, `formatters` → `package`, `ooxml`, `options`. A module may import only lower layers;
+`tach check` enforces it.
+
+Security issues: see [SECURITY.md](https://github.com/carbotek/carbotek/blob/main/SECURITY.md).
+
+## License
+
+carbotek is licensed under the [PolyForm Noncommercial License 1.0.0](https://github.com/carbotek/carbotek/blob/main/LICENSE).
+Copyright (c) 2026 Carbotek.
+
+It is derived from Carbone v3.2.3, Copyright (c) CarboneIO SAS and contributors, licensed under
+the [Apache License 2.0](https://github.com/carbotek/carbotek/blob/main/licenses/Carbone-Apache-2.0.txt). The original code was translated from
+JavaScript to Python and Rust and substantially modified. See [NOTICE](https://github.com/carbotek/carbotek/blob/main/NOTICE) and
+[THIRD_PARTY_LICENSES.md](https://github.com/carbotek/carbotek/blob/main/THIRD_PARTY_LICENSES.md).
+

carbotek-0.1.0/README.md

@@ -0,0 +1,269 @@
+# carbotek
+
+<p align="center">
+  <a href="https://github.com/carbotek/carbotek/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/carbotek/carbotek/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/carbotek/"><img alt="PyPI" src="https://img.shields.io/pypi/v/carbotek?color=blue"></a>
+  <img alt="Python" src="https://img.shields.io/badge/python-3.15%2B-3776AB?logo=python&logoColor=white">
+  <img alt="Rust" src="https://img.shields.io/badge/native-Rust%201.99-CE422B?logo=rust&logoColor=white">
+  <a href="https://github.com/carbotek/carbotek/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-PolyForm%20Noncommercial%201.0.0-orange"></a>
+  <br>
+  <a href="https://github.com/astral-sh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
+  <a href="https://github.com/astral-sh/uv"><img alt="uv" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json"></a>
+  <a href="https://microsoft.github.io/pyright/"><img alt="Checked with pyright" src="https://microsoft.github.io/pyright/img/pyright_badge.svg"></a>
+  <a href="https://docs.gauge.sh"><img alt="Architecture: tach" src="https://img.shields.io/badge/architecture-tach-6C47FF"></a>
+  <img alt="Typed" src="https://img.shields.io/badge/typing-typed-brightgreen">
+  <img alt="Carbone syntax" src="https://img.shields.io/badge/Carbone%20syntax-5.14.4-2E7D32">
+</p>
+
+**English** | [Русский](https://github.com/carbotek/carbotek/blob/main/README.ru.md)
+
+Render DOCX and XLSX templates with Carbone-style markers (`{d.name}`, loops, conditions,
+formatters, images, barcodes, HTML, hyperlinks, colors) into DOCX, XLSX or PDF from Python.
+There is no LibreOffice: PDF is produced by [`dxpdf`](https://pypi.org/project/dxpdf/).
+
+carbotek is a Python port of the DOCX and XLSX engine of [Carbone](https://github.com/carboneio/carbone)
+**v3.2.3**, the last Carbone release under the Apache License 2.0. The template syntax is compatible
+with Carbone **5.14.4**. Behaviour was checked against the JavaScript engine with a differential
+corpus and formatter oracles.
+
+carbotek is an independent project and is not affiliated with or endorsed by CarboneIO SAS.
+"Carbone" is used only to describe compatibility.
+
+> Licensed under the **PolyForm Noncommercial 1.0.0** license. It is free for noncommercial
+> use; commercial use requires a separate license (see [LICENSE](https://github.com/carbotek/carbotek/blob/main/LICENSE)).
+
+## Installation
+
+```bash
+pip install carbotek        # or: uv add carbotek
+```
+
+Requires CPython 3.15+. The primary target is Linux in Docker (`python:3.15-slim-trixie`); CI runs
+the test suite against the released wheel inside that image.
+
+Linux wheels (manylinux, x86_64 and aarch64, one abi3 wheel for CPython 3.15+) contain an optional native accelerator (`carbotek._native`, Rust) that renders common
+loop tables and money formatting faster; the output is identical to the pure-Python path. A
+source-distribution install builds the accelerator and needs a Rust toolchain (1.87+). Set `CARBOTEK_NATIVE=0` to render without it, or `CARBOTEK_NATIVE=1` to make a
+missing extension an import error; the variable is read once, when `carbotek` is imported.
+
+A universal `py3-none-any` wheel is also published for environments without Rust. Pip prefers
+an available platform wheel; select the universal wheel explicitly to install only the Python
+renderer. From an unpacked source distribution, build it with
+`uv run --no-project --with build --with setuptools --with wheel python tools/build_pure_wheel.py --out dist`.
+
+## Library
+
+```python
+import json
+import carbotek
+
+template = open("invoice.docx", "rb").read()
+data = json.load(open("data.json", encoding="utf-8"))
+
+docx = carbotek.render(template, data, {"lang": "en", "timezone": "Europe/London"})
+pdf = carbotek.render_pdf(template, data, image_dpi=220)   # DOCX templates only
+
+engine = carbotek.Engine(cache_size=16)   # own compiled-template cache
+engine.render(template, data)
+print(engine.metrics)                     # size, bytes, hits, misses, hit_rate
+```
+
+`carbotek.render` detects the template type: a DOCX template returns DOCX, an XLSX template
+returns XLSX. The module-level functions share one default `Engine`.
+
+### Options
+
+Options are the keys of `RenderOptions.create`:
+
+| Key | Meaning |
+|---|---|
+| `lang` | Document language (default `ru`) |
+| `timezone` | IANA time zone (default `Europe/Moscow`) |
+| `complement` | `{c.*}` data |
+| `translations` | `{t(...)}` dictionaries |
+| `enum` | Enumerations for `convEnum` |
+| `currency` | `{"source", "target", "rates"}` |
+| `variable_str` | Template variables |
+| `use_high_precision_arithmetic` | High-precision arithmetic |
+| `export_formatted_values_as_text` | XLSX: keep formatted numbers as text |
+
+### Russian formatters
+
+carbotek adds formatters for Russian business documents (they are not part of Carbone):
+
+| Formatter (aliases) | Example | Result |
+|---|---|---|
+| `digitCurrency` (`numCurrency`, `numberCurrency`, `digitalCurrency`) | `{d.a:digitCurrency}`, a = 1234567.5 | `1 234 567,50` |
+| | `{d.a:digitCurrency(0)}` | `1 234 568` |
+| `formatAmount` | `{d.a:formatAmount}`, a = 1234.5 | `1 234,50` |
+| `wordNumber` (`words`, `numberToWords`) | `{d.a:wordNumber}`, a = 1234 | `одна тысяча двести тридцать четыре` |
+| `wordCurrency` | `{d.a:wordCurrency}`, a = 1234.56 | `Одна тысяча двести тридцать четыре рубля 56 копеек` |
+| `moneyFull` (`sumFull`) | `{d.a:moneyFull}`, a = 1234.56 | `1 234,56 (Одна тысяча двести тридцать четыре рубля 56 копеек)` |
+| `procent` (`percent`) | `{d.a:procent}`, a = 20 | `20,00 %` |
+| `dashIfZero` (`dashZero`) | `{d.a:dashIfZero}`, a = 0 | `—` |
+| `plural` (`pluralize`) | `{d.n:plural('день','дня','дней')}`, n = 5 | `5 дней` |
+| | `{d.n:plural('день','дня','дней', false)}`, n = 21 | `день` |
+| `ruDate` | `{d.dt:ruDate}`, dt = `2026-10-11` | `«11» октября 2026` |
+| `roundHalfUp` | `{d.a:roundHalfUp(1)}`, a = 2.25 | `2.3` |
+| `parseAmount` | `{d.s:parseAmount}`, s = `1 234,50` | `1234.5` |
+| `parseDate` | `{d.s:parseDate}`, s = `11.10.2026` | `2026-10-11` |
+| `capitalize` (`firstUpper`) | `{d.s:capitalize}`, s = `иванов` | `Иванов` |
+
+Amount formatters take an optional precision (default 2) and round half up. `ruDate` uses the
+render time zone, or the one given as an argument.
+
+### Errors
+
+All template and data errors are subclasses of `carbotek.CarbotekError`. Each error has a stable
+`code`:
+
+| Code | Error |
+|---|---|
+| `VALIDATION_ERROR` | Invalid input |
+| `TEMPLATE_ERROR` | Invalid template, marker or formatter |
+| `FEATURE_UNAVAILABLE` | Unsupported feature |
+| `CONVERTER_ERROR` | PDF conversion failed |
+
+Messages follow the JS engine where applicable; input and infrastructure failures have library-specific messages.
+
+### Images from URLs and files
+
+By default, only data URIs are loaded. Remote and local images have to be enabled explicitly:
+
+```python
+from carbotek.features.fetch import ImageSourceConfig
+
+engine = carbotek.Engine(image_sources=ImageSourceConfig(
+    allowlist=("cdn.example.com",),   # hosts allowed for http(s) images; private addresses are refused
+    file_root="/srv/images",          # file:// images are read only under this directory
+    max_bytes=10_485_760,
+    fetch_timeout_ms=5000,
+    max_download_concurrency=4,
+    total_timeout_ms=10000,
+))
+```
+
+Without `image_sources`, the same settings are read from environment variables:
+
+- `CARBOTEK__IMAGE_URL_ALLOWLIST` (comma-separated)
+- `CARBOTEK__IMAGE_FILE_ROOT`
+- `CARBOTEK__IMAGE_MAX_BYTES`
+- `CARBOTEK__IMAGE_FETCH_TIMEOUT_MS`
+- `CARBOTEK__IMAGE_MAX_DOWNLOAD_CONCURRENCY`
+- `CARBOTEK__IMAGE_TOTAL_TIMEOUT_MS`
+
+Environment settings are snapshotted once at the start of each render. Changes during a render affect the next call; an explicit `ImageSourceConfig` takes precedence. Image limits must be positive integers; invalid environment limits raise `ValidationError`. Explicit configuration also validates field types and copies/normalizes the allowlist.
+
+## XLSX
+
+XLSX templates render to XLSX the same way as in Carbone. Supported:
+
+- markers;
+- loops over rows and cells, including nested loops;
+- conditions and conditional blocks;
+- `drop`/`keep` (`row`, `col`, `table`);
+- aggregates and variables.
+
+The workbook is prepared as in the JS engine:
+
+- `calcChain.xml` is removed;
+- shared strings become inline strings;
+- a cell whose only content is a `:formatN` marker becomes numeric. To keep it as text, use the `export_formatted_values_as_text` option or `{o.exportFormattedValuesAsText=true}`.
+
+Markers work anywhere in the workbook: sheet names, headers and footers, defined names, comments.
+
+- **Pictures:** put a marker in the alt text of a sheet picture, for example `{d.logo}` or `{d.code:barcode(ean13)}`.
+- **Hyperlinks:** a hyperlink target `https://d.site` becomes `{d.site:validateURL}`.
+- **Not recalculated:** formulas, `dimension` and merged cells.
+- **No PDF output:** PDF from XLSX raises `FeatureUnavailable`.
+
+## CLI
+
+```bash
+carbotek render template.docx data.json -o out.docx
+carbotek render template.xlsx data.json                    # -> template.out.xlsx
+carbotek render template.docx data.json --pdf -o out.pdf --image-dpi 300
+carbotek bench  template.docx data.json -n 50              # warm cache: cold, mean, p50, p95, min, max, per second
+carbotek bench  template.docx data.json --no-cache --json   # reset module caches and registry for each render
+carbotek markers template.docx                             # markers per part after validated compilation
+```
+
+`python -m carbotek ...` works too.
+
+Common flags:
+
+- `--lang`, `--timezone`;
+- `--options '{"complement": {"company": "X"}}'`;
+- `-` instead of the data file reads data from stdin.
+
+## Using it in a web service / task queue
+
+The API is synchronous and CPU-bound. It takes bytes and returns bytes, and does no I/O except
+the optional image downloads.
+
+- **Create one `Engine` per process** and reuse it, so compiled templates are cached. `Engine` is thread-safe.
+- **Do not call it on the event loop.**
+  - In an async framework, use `await asyncio.to_thread(engine.render, template, data, options)`.
+  - For a task queue (for example taskiq or Celery), a synchronous task with process-based workers scales best, because rendering holds the GIL.
+- **Map `CarbotekError` to client errors (4xx)** by its `code`. Any other exception is a server error.
+- **Install the template fonts in the container** (or metric-compatible fonts such as Carlito/Caladea). PDF uses system fonts.
+
+```python
+import asyncio
+import carbotek
+
+engine = carbotek.Engine(cache_size=64)
+
+async def render_document(template: bytes, data: dict, pdf: bool) -> bytes:
+    if pdf:
+        return await asyncio.to_thread(engine.render_pdf, template, data)
+    return await asyncio.to_thread(engine.render, template, data)
+```
+
+## Limitations
+
+- **ECharts charts are not supported.** A `{d.x:chart}` marker raises `FeatureUnavailable`. Native Word/Excel charts are updated with the data.
+- **PDF has no bookmark outline and no document information** (title, author).
+- **Native OOXML charts are not drawn in PDF.** Their data in the DOCX is still updated.
+- **WMF/EMF images are drawn only partially in PDF.** A warning is logged.
+- **The table of contents is not recalculated.** Page numbers come from the template.
+- **An even/odd-page section break acts like `nextPage`.**
+
+## Differences from Carbone
+
+Deliberate, documented differences from the JavaScript engine:
+
+- A `{o.*}` option split across runs by Word is applied (Carbone leaves it in the text).
+- An object or array printed by a marker uses JavaScript string conversion (`[object Object]`, `1,2`).
+- A named sort combined with a repeater renders (Carbone fails to compile that template).
+- An empty native chart series is written as `ptCount=0`, as OOXML requires.
+- Items without a named sort key keep their input order.
+- Each picture keeps its own frame size when several pictures use the same image marker (Carbone
+  applies the size of the last of them to all).
+- Native wheels are built only for Linux; other platforms install the pure-Python wheel, which is not tested there.
+
+## Development
+
+```bash
+uv sync                      # builds the native extension; needs the Rust toolchain from rust-toolchain.toml
+uv run ruff check . && uv run ruff format --check .
+uv run pyright               # strict mode, per-file headers
+uv run tach check            # layer boundaries, see tach.toml
+uv run pytest -n auto
+```
+
+Layers, from top to bottom: `cli` → `api` → `pipeline`, `opc`, `pdf` → `features`, `xlsx` → `docx`
+→ `markers`, `formatters` → `package`, `ooxml`, `options`. A module may import only lower layers;
+`tach check` enforces it.
+
+Security issues: see [SECURITY.md](https://github.com/carbotek/carbotek/blob/main/SECURITY.md).
+
+## License
+
+carbotek is licensed under the [PolyForm Noncommercial License 1.0.0](https://github.com/carbotek/carbotek/blob/main/LICENSE).
+Copyright (c) 2026 Carbotek.
+
+It is derived from Carbone v3.2.3, Copyright (c) CarboneIO SAS and contributors, licensed under
+the [Apache License 2.0](https://github.com/carbotek/carbotek/blob/main/licenses/Carbone-Apache-2.0.txt). The original code was translated from
+JavaScript to Python and Rust and substantially modified. See [NOTICE](https://github.com/carbotek/carbotek/blob/main/NOTICE) and
+[THIRD_PARTY_LICENSES.md](https://github.com/carbotek/carbotek/blob/main/THIRD_PARTY_LICENSES.md).