brewdoc 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +23 -20
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -3,37 +3,40 @@
3
3
  [![PyPI](https://img.shields.io/pypi/v/brewdoc)](https://pypi.org/project/brewdoc/)
4
4
  [![CI](https://github.com/kochetkov-ma/brewdoc/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kochetkov-ma/brewdoc/actions/workflows/ci.yml)
5
5
  [![Release](https://img.shields.io/github/v/release/kochetkov-ma/brewdoc)](https://github.com/kochetkov-ma/brewdoc/releases/latest)
6
- [![MIT](https://img.shields.io/github/license/kochetkov-ma/brewdoc)](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/LICENSE)
6
+ [![MIT](https://img.shields.io/github/license/kochetkov-ma/brewdoc)](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/LICENSE)
7
7
 
8
8
  Fast, deterministic document-to-Markdown conversion for agent systems. Easy to install. No model weights, OCR or external services.
9
9
 
10
10
  Local conversion runs offline after installation, with no runtime component downloads.
11
11
  Supported documents become one Markdown file and a JSON receipt describing omissions.
12
- See [formats and limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/FORMATS.md).
12
+ See [formats and limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md).
13
+ Version 0.4.1 adds [selected ZIP/XML reader budgets](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md#zipxml-reader-limits)
14
+ for DOCX/PPTX and workbook metadata/artifacts. Excessive work refuses before output
15
+ writes; native workbook values and total process memory remain outside those bounds.
13
16
 
14
17
  ## Install
15
18
 
16
- These examples select 0.4.0. Use a channel listed as available in [that release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.4.0). Choose one method:
19
+ These examples select 0.4.1. Use a channel listed as available in [that release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.4.1). Choose one method:
17
20
 
18
21
  Article mode is introduced in 0.4.0. Channel availability is listed in the release.
19
22
 
20
23
  ```sh
21
- python -m pip install "brewdoc==0.4.0"
22
- uv tool install --python 3.12 "brewdoc==0.4.0"
23
- pipx install --python 3.12 "brewdoc==0.4.0"
24
+ python -m pip install "brewdoc==0.4.1"
25
+ uv tool install --python 3.12 "brewdoc==0.4.1"
26
+ pipx install --python 3.12 "brewdoc==0.4.1"
24
27
  ```
25
28
 
26
29
  Use a virtual environment for pip. Python 3.12+ is required; HTML/URL need CPython 3.12-3.14.
27
- [INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/INSTALL.md) covers prerequisites, Windows, uvx, PATH, update and removal.
30
+ [INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/INSTALL.md) covers prerequisites, Windows, uvx, PATH, update and removal.
28
31
  [Latest release](https://github.com/kochetkov-ma/brewdoc/releases/latest) lists actual assets and channel availability.
29
32
 
30
33
  ### Standalone downloads
31
34
 
32
- Use downloads listed as available in the release. Python and dependencies are bundled. Verify [SHA256SUMS](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.0/SHA256SUMS) and keep the entire extracted directory.
35
+ Use downloads listed as available in the release. Python and dependencies are bundled. Verify [SHA256SUMS](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.1/SHA256SUMS) and keep the entire extracted directory.
33
36
 
34
- [![Linux x64 download](https://img.shields.io/badge/Linux_x64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.0/brewdoc-0.4.0-linux-x64.tar.gz)
35
- [![Windows x64 download](https://img.shields.io/badge/Windows_x64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.0/brewdoc-0.4.0-windows-x64.zip)
36
- [![macOS ARM64 download](https://img.shields.io/badge/macOS_ARM64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.0/brewdoc-0.4.0-macos-arm64.tar.gz)
37
+ [![Linux x64 download](https://img.shields.io/badge/Linux_x64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.1/brewdoc-0.4.1-linux-x64.tar.gz)
38
+ [![Windows x64 download](https://img.shields.io/badge/Windows_x64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.1/brewdoc-0.4.1-windows-x64.zip)
39
+ [![macOS ARM64 download](https://img.shields.io/badge/macOS_ARM64-download-blue)](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.4.1/brewdoc-0.4.1-macos-arm64.tar.gz)
37
40
 
38
41
  | Native target | Verification environment | JavaScript |
39
42
  |---|---|---|
@@ -43,15 +46,15 @@ Use downloads listed as available in the release. Python and dependencies are bu
43
46
 
44
47
  Older OSes, Linux musl/ARM64 and macOS Intel are outside this binary set.
45
48
  Windows is unsigned; macOS has an ad hoc signature without Developer ID/notarization.
46
- Linux archives have checksums, without a detached publisher signature. [Download and launch](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/INSTALL.md#standalone).
49
+ Linux archives have checksums, without a detached publisher signature. [Download and launch](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/INSTALL.md#standalone).
47
50
 
48
51
  ### npm
49
52
 
50
53
  [![npm](https://img.shields.io/npm/v/brewdoc)](https://www.npmjs.com/package/brewdoc)
51
54
 
52
55
  npm targets Linux x64/glibc and macOS ARM64. Windows uses the GitHub native download or Python package.
53
- Use npm/npx only when listed as available in [the release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.4.0).
54
- [INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/INSTALL.md#npm-and-npx) contains exact-version installation, update and removal instructions.
56
+ Use npm/npx only when listed as available in [the release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.4.1).
57
+ [INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/INSTALL.md#npm-and-npx) contains exact-version installation, update and removal instructions.
55
58
 
56
59
  ## Usage
57
60
 
@@ -125,12 +128,12 @@ brewdoc --url https://example.com/article --render-js --timeout 30 --out article
125
128
  Public destinations, DNS, redirects, TLS, requests and bytes are validated. Ordinary requests use GET;
126
129
  JS admits only the narrow credential-free HN Algolia XHR POST exception. Local HTML never fetches or runs scripts.
127
130
  Optional JS needs installed/bundled prerequisites, refuses unsupported runtimes before HTTP and downloads no engine.
128
- Timing-only expiry can preserve valid partial content; hard failures refuse output. [Full URL/JS limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/FORMATS.md#url-acquisition).
131
+ Timing-only expiry can preserve valid partial content; hard failures refuse output. [Full URL/JS limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md#url-acquisition).
129
132
 
130
133
  ## Article mode
131
134
 
132
135
  Introduced in 0.4.0; use a channel listed as available in the release. For Python JS capture, install
133
- `brewdoc[render-js]==0.4.0`; supported standalone bundles include its prerequisites.
136
+ `brewdoc[render-js]==0.4.1`; supported standalone bundles include its prerequisites.
134
137
 
135
138
  ```sh
136
139
  brewdoc page.html --article --out article.md
@@ -152,7 +155,7 @@ without layout or inferred author/date metadata. The source title is unchanged.
152
155
 
153
156
  The receipt's `not_carried` and successful Markdown's Known omissions declare:
154
157
  `body content outside the selected article or main subtree; complete page coverage is not claimed`.
155
- The [article contract](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/FORMATS.md#article-selection)
158
+ The [article contract](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md#article-selection)
156
159
  defines selection, refusals and limits.
157
160
 
158
161
  [Source-package CI](https://github.com/kochetkov-ma/brewdoc/actions/runs/38431645006) passed on
@@ -163,10 +166,10 @@ tested patches, not a claim about newer versions. CPython 3.12.14 retains the lo
163
166
  full-suite baseline and existing CI smoke checks. Package evidence is separate from the
164
167
  standalone binaries; other OS/minor combinations, free-threaded CPython and other
165
168
  architectures remain untested here.
166
- See [package compatibility](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/FORMATS.md#python-package-compatibility).
169
+ See [package compatibility](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md#python-package-compatibility).
167
170
 
168
- [Format contracts](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/FORMATS.md) | [Corpus](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/benchmarks/CATALOG.md) | [Measurements](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/benchmarks/METHODOLOGY.md) | [Results](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/benchmarks/results/README.md)
169
- [Releasing](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/RELEASING.md) | [Agent entry point](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/llms.txt) | [MIT license](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.0/LICENSE)
171
+ [Format contracts](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/FORMATS.md) | [Corpus](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/benchmarks/CATALOG.md) | [Measurements](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/benchmarks/METHODOLOGY.md) | [Results](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/benchmarks/results/README.md)
172
+ [Releasing](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/RELEASING.md) | [Agent entry point](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/llms.txt) | [MIT license](https://github.com/kochetkov-ma/brewdoc/blob/v0.4.1/LICENSE)
170
173
 
171
174
  ## Related projects
172
175
 
package/package.json CHANGED
@@ -29,8 +29,8 @@
29
29
  "license": "MIT",
30
30
  "name": "brewdoc",
31
31
  "optionalDependencies": {
32
- "brewdoc-darwin-arm64": "0.4.0",
33
- "brewdoc-linux-x64-glibc": "0.4.0"
32
+ "brewdoc-darwin-arm64": "0.4.1",
33
+ "brewdoc-linux-x64-glibc": "0.4.1"
34
34
  },
35
35
  "publishConfig": {
36
36
  "access": "public",
@@ -40,5 +40,5 @@
40
40
  "type": "git",
41
41
  "url": "git+https://github.com/kochetkov-ma/brewdoc.git"
42
42
  },
43
- "version": "0.4.0"
43
+ "version": "0.4.1"
44
44
  }