brewdoc 0.3.2 → 0.3.3
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.
- package/README.md +24 -17
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -3,35 +3,35 @@
|
|
|
3
3
|
[](https://pypi.org/project/brewdoc/)
|
|
4
4
|
[](https://github.com/kochetkov-ma/brewdoc/actions/workflows/ci.yml)
|
|
5
5
|
[](https://github.com/kochetkov-ma/brewdoc/releases/latest)
|
|
6
|
-
[](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
6
|
+
[](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/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 [supported formats and limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
12
|
+
See [supported formats and limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/FORMATS.md).
|
|
13
13
|
|
|
14
14
|
## Install
|
|
15
15
|
|
|
16
|
-
These examples select 0.3.
|
|
16
|
+
These examples select 0.3.3. Use a channel listed as available in [that release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.3.3). Choose one method:
|
|
17
17
|
|
|
18
18
|
```sh
|
|
19
|
-
python -m pip install "brewdoc==0.3.
|
|
20
|
-
uv tool install --python 3.12 "brewdoc==0.3.
|
|
21
|
-
pipx install --python 3.12 "brewdoc==0.3.
|
|
19
|
+
python -m pip install "brewdoc==0.3.3"
|
|
20
|
+
uv tool install --python 3.12 "brewdoc==0.3.3"
|
|
21
|
+
pipx install --python 3.12 "brewdoc==0.3.3"
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Use a virtual environment for pip. Python 3.12+ is required; HTML/URL need CPython 3.12-3.14.
|
|
25
|
-
[INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
25
|
+
[INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/INSTALL.md) covers prerequisites, Windows, uvx, PATH, update and removal.
|
|
26
26
|
[Latest release](https://github.com/kochetkov-ma/brewdoc/releases/latest) lists actual assets and channel availability.
|
|
27
27
|
|
|
28
28
|
### Standalone downloads
|
|
29
29
|
|
|
30
|
-
Use downloads listed as available in the release. Python and dependencies are bundled. Verify [SHA256SUMS](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.
|
|
30
|
+
Use downloads listed as available in the release. Python and dependencies are bundled. Verify [SHA256SUMS](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.3/SHA256SUMS) and keep the entire extracted directory.
|
|
31
31
|
|
|
32
|
-
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.
|
|
33
|
-
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.
|
|
34
|
-
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.
|
|
32
|
+
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.3/brewdoc-0.3.3-linux-x64.tar.gz)
|
|
33
|
+
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.3/brewdoc-0.3.3-windows-x64.zip)
|
|
34
|
+
[](https://github.com/kochetkov-ma/brewdoc/releases/download/v0.3.3/brewdoc-0.3.3-macos-arm64.tar.gz)
|
|
35
35
|
|
|
36
36
|
| Native target | Verification environment | JavaScript |
|
|
37
37
|
|---|---|---|
|
|
@@ -41,15 +41,15 @@ Use downloads listed as available in the release. Python and dependencies are bu
|
|
|
41
41
|
|
|
42
42
|
Older OSes, Linux musl/ARM64 and macOS Intel are outside this binary set.
|
|
43
43
|
Windows is unsigned; macOS has an ad hoc signature without Developer ID/notarization.
|
|
44
|
-
Linux archives have checksums, without a detached publisher signature. [Download and launch](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
44
|
+
Linux archives have checksums, without a detached publisher signature. [Download and launch](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/INSTALL.md#standalone).
|
|
45
45
|
|
|
46
46
|
### npm
|
|
47
47
|
|
|
48
48
|
[](https://www.npmjs.com/package/brewdoc)
|
|
49
49
|
|
|
50
50
|
npm targets Linux x64/glibc and macOS ARM64. Windows uses the GitHub native download or Python package.
|
|
51
|
-
Use npm/npx only when listed as available in [the release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.3.
|
|
52
|
-
[INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
51
|
+
Use npm/npx only when listed as available in [the release](https://github.com/kochetkov-ma/brewdoc/releases/tag/v0.3.3).
|
|
52
|
+
[INSTALL.md](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/INSTALL.md#npm-and-npx) contains exact-version installation, update and removal instructions.
|
|
53
53
|
|
|
54
54
|
## Usage
|
|
55
55
|
|
|
@@ -123,7 +123,14 @@ brewdoc --url https://example.com/article --render-js --timeout 30 --out article
|
|
|
123
123
|
Public destinations, DNS, redirects, TLS, requests and bytes are validated. Ordinary requests use GET;
|
|
124
124
|
JS admits only the narrow credential-free HN Algolia XHR POST exception. Local HTML never fetches or runs scripts.
|
|
125
125
|
Optional JS needs installed/bundled prerequisites, refuses unsupported runtimes before HTTP and downloads no engine.
|
|
126
|
-
Timing-only expiry can preserve valid partial content; hard failures refuse output. [Full URL/JS limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
126
|
+
Timing-only expiry can preserve valid partial content; hard failures refuse output. [Full URL/JS limits](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/FORMATS.md#url-acquisition).
|
|
127
127
|
|
|
128
|
-
[Format contracts](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
129
|
-
[Releasing](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.
|
|
128
|
+
[Format contracts](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/FORMATS.md) | [Corpus](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/benchmarks/CATALOG.md) | [Measurements](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/benchmarks/METHODOLOGY.md) | [Results](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/benchmarks/results/README.md)
|
|
129
|
+
[Releasing](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/RELEASING.md) | [Agent entry point](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/llms.txt) | [MIT license](https://github.com/kochetkov-ma/brewdoc/blob/v0.3.3/LICENSE)
|
|
130
|
+
|
|
131
|
+
## Related projects
|
|
132
|
+
|
|
133
|
+
- [BrewPage](https://brewpage.app): free hosting for HTML, Markdown, JSON and files; each upload returns a shareable HTTPS link.
|
|
134
|
+
- [BrewPage MCP server](https://github.com/kochetkov-ma/brewpage-openapi/tree/main/mcp-server): npm package `brewpage-mcp` for publishing to BrewPage from MCP clients.
|
|
135
|
+
- [claude-brewcode](https://github.com/kochetkov-ma/claude-brewcode): plugin suite for Claude Code, with [documentation](https://doc-claude.brewcode.app). Its brewdoc plugin is a different tool from this brewdoc CLI.
|
|
136
|
+
- [brewcode.app](https://brewcode.app): home site of the Brew projects.
|
package/package.json
CHANGED
|
@@ -29,8 +29,8 @@
|
|
|
29
29
|
"license": "MIT",
|
|
30
30
|
"name": "brewdoc",
|
|
31
31
|
"optionalDependencies": {
|
|
32
|
-
"brewdoc-darwin-arm64": "0.3.
|
|
33
|
-
"brewdoc-linux-x64-glibc": "0.3.
|
|
32
|
+
"brewdoc-darwin-arm64": "0.3.3",
|
|
33
|
+
"brewdoc-linux-x64-glibc": "0.3.3"
|
|
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.3.
|
|
43
|
+
"version": "0.3.3"
|
|
44
44
|
}
|