proofix 0.5.0__tar.gz

proofix-0.5.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+.proofix/
+*.report.md

proofix-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andrew Brož
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

proofix-0.5.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.5
+Name: proofix
+Version: 0.5.0
+Summary: Fix typos and punctuation in Markdown: LanguageTool detects, a language model adjudicates, comma placement is corrected under a diff guard.
+Project-URL: Homepage, https://github.com/AndrewBroz/proofix
+Project-URL: Issues, https://github.com/AndrewBroz/proofix/issues
+Author: Andrew Brož
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.11
+Requires-Dist: adjudicate<0.4,>=0.3
+Description-Content-Type: text/markdown
+
+# proofix
+
+Fix typos and punctuation in a Markdown file, under audit. Every change is
+one bounded, logged, reasoned edit; the model never rewrites prose.
+
+```
+proofix draft.md                      # -> draft.proofed.md (US English)
+proofix draft.md --target uk --changes
+```
+
+Run it after [stylefix](https://github.com/AndrewBroz/stylefix), so the grammar checker sees the target variety.
+
+## Five tiers
+
+| tier | what | how | who decides |
+|---|---|---|---|
+| 0 hygiene | text that renders fine but is not what it looks like: HTML entities Markdown can carry plainly (`&#32;`, `&quot;`, `&mdash;`), zero-width spaces, byte-order marks, soft hyphens, control characters, Windows line endings, decomposed accents | fixed deterministically and logged; entities that would change Markdown's parsing (`&lt;`, `&gt;`, `&amp;`) or carry meaning (`&nbsp;`) are left alone and reported | applied outright, or noted |
+| 1 mechanical | space before a comma or period, missing space after one, doubled punctuation, doubled words, known misspellings | LanguageTool's single-answer rules, the `typos` tool, a small missing-space rule | applied outright |
+| 2 adjudicated | unknown words with candidate spellings, grammar rules with candidate fixes ("a comma may be missing after However") | LanguageTool proposes, a language model picks one or KEEP from the sentence and the rule's message | model |
+| 3 compounds and consistency | how a compound is written: "cyber attack" or "cyberattack", "non-profit" or "nonprofit", "long term" or "long-term"; and terms the document capitalises two ways | candidates found from the dictionaries (an open or hyphenated pair whose closed form is a word; a non-word that splits into two words; anything the document itself writes two ways). The model chooses closed, hyphenated, open or KEEP, told which dictionary rules (Merriam-Webster for US, Oxford for UK) and the rule that a compound modifier before a noun is hyphenated while a noun phrase is open | model |
+| 4 commas | a comma between subject and verb, a missing comma after an introductory phrase or around a non-restrictive clause, a stray comma before "and" joining objects: nothing a rule engine detects | the model returns the sentence with commas corrected; a diff guard admits only insertions and deletions of commas, rejects anything else, and reports it | model, under the guard |
+
+LanguageTool runs twice: once for the mechanical fixes, which are applied,
+and again on the cleaned text for the judgement calls, so overlapping
+faults on one span ("clear.However" needs a space *and* a comma) are both
+fixed. Code spans, fenced code, link targets, URLs, HTML and front matter
+are never touched; link text is prose and is checked.
+
+Variety spellings ("programme", "analysed") are left to stylefix. Serial
+commas are left to stylefix's style guide. Compound spelling follows the
+target variety's dictionary, because that is what every style guide
+defers to; the guide only adds AP's lighter hyphenation. Comma splices are not "fixed"
+by changing punctuation; they are reported as notes.
+
+## What goes to the model, and how much
+
+Only the residue after the rule engines:
+
+- Tier 2: one item per LanguageTool suggestion, with the sentence and one
+  neighbour as context. Typically 1 to 4 per page.
+- Tier 3: one item per occurrence of a compound that has a question: a
+  closed form exists, or the document writes it two ways. A document that
+  is consistent and closes what the dictionary closes sends nothing.
+- Tier 4: sentences pass a gate first. A sentence is sent only if it
+  contains a comma, opens with an introductory word (After, Although,
+  However, In, When ...), contains a clause trigger (which, for example,
+  such as, said ...), or is long and joins clauses with a conjunction.
+  About two thirds of sentences pass. The model returns only the sentences
+  it changed, so replies are short. `--commas all` sends every sentence;
+  `--max-sentences N` caps the tier.
+
+Measured on a 20-page document (8,000 words, 390 sentences). One measurement, on a DGX Spark serving Qwen3.8-27B, 8 requests in parallel:
+
+| stage | sent to the model | time |
+|---|---|---|
+| stylefix | 119 words | 43 s |
+| LanguageTool, one pass | nothing (local Java) | 4.5 s |
+| proofix tier 2 | 77 items | included below |
+| proofix tier 4, gated | 260 sentences | 19 s |
+| proofix tier 4, all | 390 sentences | 24 s |
+| proofix, everything | | 57 s |
+
+Costs scale linearly with length: expect a 100-page document to take
+about four minutes in stylefix and five in proofix. Decisions are cached
+by sentence, so re-runs after edits pay only for what changed.
+
+## Install
+
+```
+uv tool install proofix       # or: pipx install proofix
+```
+
+Optional, and worth having:
+
+- [LanguageTool](https://languagetool.org) on your PATH as `languagetool`
+  (`brew install languagetool`; it needs Java). Without it, LanguageTool's
+  tier 1 fixes and all of tier 2 are skipped with a warning; hygiene, the
+  `typos` fixes, compounds and commas still run.
+- [typos](https://github.com/crate-ci/typos) (`brew install typos-cli` or
+  `cargo install typos-cli`) for known-misspelling fixes in tier 1.
+
+Run `proofix --setup` to choose and test a model endpoint, and
+`proofix --check-endpoint` to see which one proofix will use. The endpoint
+is configured as for stylefix: `--url`/`--model`,
+`PROOFIX_LLM_URL`/`_MODEL`/`_KEY`, `~/.config/proofix/config.toml`, then
+the shared `ADJUDICATE_LLM_*` and `~/.config/adjudicate/config.toml`; with
+nothing configured, a local Ollama if one is running. A `--url` or
+`PROOFIX_LLM_URL` drops keys set in lower layers; set `PROOFIX_LLM_KEY` (or
+`api_key_env` in the same config file) alongside it. Without a model, tiers
+0 and 1 still apply; tier 2's fixes are listed for review, tier 3 is skipped
+and sentences are not checked for commas. See
+[adjudicate](https://github.com/AndrewBroz/adjudicate#choosing-the-model-endpoint)
+for the config table. `STYLEFIX_LLM_*` no longer configures proofix; use the
+shared file or `ADJUDICATE_LLM_*` to set both tools at once.
+
+Accept lists: `--accept FILE`, `~/.config/proofix/accept.txt`,
+`./.proofix/accept.txt`, and stylefix's `~/.config/stylefix/accept.txt` and
+`./.stylefix/accept.txt` are all honoured for spelling.
+
+## Output
+
+`<name>.proofed.md`, a report next to it, and with `--changes` a log on
+stderr: every edit with its line, before and after, context and how it was
+decided; the comma corrections with the model's reasons; comma suggestions
+the guard rejected, with what the model wanted; notes on faults the model
+noticed but is not allowed to fix (comma splices, agreement errors, a
+missing closing quote); and LanguageTool matches with no fix.
+
+## License
+
+MIT (see `LICENSE`).
+
+## Development
+
+```
+uv sync
+uv run pytest   # LanguageTool is replayed from a fixture; the model is a stub
+```

proofix-0.5.0/README.md

@@ -0,0 +1,118 @@
+# proofix
+
+Fix typos and punctuation in a Markdown file, under audit. Every change is
+one bounded, logged, reasoned edit; the model never rewrites prose.
+
+```
+proofix draft.md                      # -> draft.proofed.md (US English)
+proofix draft.md --target uk --changes
+```
+
+Run it after [stylefix](https://github.com/AndrewBroz/stylefix), so the grammar checker sees the target variety.
+
+## Five tiers
+
+| tier | what | how | who decides |
+|---|---|---|---|
+| 0 hygiene | text that renders fine but is not what it looks like: HTML entities Markdown can carry plainly (` `, `"`, `—`), zero-width spaces, byte-order marks, soft hyphens, control characters, Windows line endings, decomposed accents | fixed deterministically and logged; entities that would change Markdown's parsing (`<`, `>`, `&`) or carry meaning (` `) are left alone and reported | applied outright, or noted |
+| 1 mechanical | space before a comma or period, missing space after one, doubled punctuation, doubled words, known misspellings | LanguageTool's single-answer rules, the `typos` tool, a small missing-space rule | applied outright |
+| 2 adjudicated | unknown words with candidate spellings, grammar rules with candidate fixes ("a comma may be missing after However") | LanguageTool proposes, a language model picks one or KEEP from the sentence and the rule's message | model |
+| 3 compounds and consistency | how a compound is written: "cyber attack" or "cyberattack", "non-profit" or "nonprofit", "long term" or "long-term"; and terms the document capitalises two ways | candidates found from the dictionaries (an open or hyphenated pair whose closed form is a word; a non-word that splits into two words; anything the document itself writes two ways). The model chooses closed, hyphenated, open or KEEP, told which dictionary rules (Merriam-Webster for US, Oxford for UK) and the rule that a compound modifier before a noun is hyphenated while a noun phrase is open | model |
+| 4 commas | a comma between subject and verb, a missing comma after an introductory phrase or around a non-restrictive clause, a stray comma before "and" joining objects: nothing a rule engine detects | the model returns the sentence with commas corrected; a diff guard admits only insertions and deletions of commas, rejects anything else, and reports it | model, under the guard |
+
+LanguageTool runs twice: once for the mechanical fixes, which are applied,
+and again on the cleaned text for the judgement calls, so overlapping
+faults on one span ("clear.However" needs a space *and* a comma) are both
+fixed. Code spans, fenced code, link targets, URLs, HTML and front matter
+are never touched; link text is prose and is checked.
+
+Variety spellings ("programme", "analysed") are left to stylefix. Serial
+commas are left to stylefix's style guide. Compound spelling follows the
+target variety's dictionary, because that is what every style guide
+defers to; the guide only adds AP's lighter hyphenation. Comma splices are not "fixed"
+by changing punctuation; they are reported as notes.
+
+## What goes to the model, and how much
+
+Only the residue after the rule engines:
+
+- Tier 2: one item per LanguageTool suggestion, with the sentence and one
+  neighbour as context. Typically 1 to 4 per page.
+- Tier 3: one item per occurrence of a compound that has a question: a
+  closed form exists, or the document writes it two ways. A document that
+  is consistent and closes what the dictionary closes sends nothing.
+- Tier 4: sentences pass a gate first. A sentence is sent only if it
+  contains a comma, opens with an introductory word (After, Although,
+  However, In, When ...), contains a clause trigger (which, for example,
+  such as, said ...), or is long and joins clauses with a conjunction.
+  About two thirds of sentences pass. The model returns only the sentences
+  it changed, so replies are short. `--commas all` sends every sentence;
+  `--max-sentences N` caps the tier.
+
+Measured on a 20-page document (8,000 words, 390 sentences). One measurement, on a DGX Spark serving Qwen3.8-27B, 8 requests in parallel:
+
+| stage | sent to the model | time |
+|---|---|---|
+| stylefix | 119 words | 43 s |
+| LanguageTool, one pass | nothing (local Java) | 4.5 s |
+| proofix tier 2 | 77 items | included below |
+| proofix tier 4, gated | 260 sentences | 19 s |
+| proofix tier 4, all | 390 sentences | 24 s |
+| proofix, everything | | 57 s |
+
+Costs scale linearly with length: expect a 100-page document to take
+about four minutes in stylefix and five in proofix. Decisions are cached
+by sentence, so re-runs after edits pay only for what changed.
+
+## Install
+
+```
+uv tool install proofix       # or: pipx install proofix
+```
+
+Optional, and worth having:
+
+- [LanguageTool](https://languagetool.org) on your PATH as `languagetool`
+  (`brew install languagetool`; it needs Java). Without it, LanguageTool's
+  tier 1 fixes and all of tier 2 are skipped with a warning; hygiene, the
+  `typos` fixes, compounds and commas still run.
+- [typos](https://github.com/crate-ci/typos) (`brew install typos-cli` or
+  `cargo install typos-cli`) for known-misspelling fixes in tier 1.
+
+Run `proofix --setup` to choose and test a model endpoint, and
+`proofix --check-endpoint` to see which one proofix will use. The endpoint
+is configured as for stylefix: `--url`/`--model`,
+`PROOFIX_LLM_URL`/`_MODEL`/`_KEY`, `~/.config/proofix/config.toml`, then
+the shared `ADJUDICATE_LLM_*` and `~/.config/adjudicate/config.toml`; with
+nothing configured, a local Ollama if one is running. A `--url` or
+`PROOFIX_LLM_URL` drops keys set in lower layers; set `PROOFIX_LLM_KEY` (or
+`api_key_env` in the same config file) alongside it. Without a model, tiers
+0 and 1 still apply; tier 2's fixes are listed for review, tier 3 is skipped
+and sentences are not checked for commas. See
+[adjudicate](https://github.com/AndrewBroz/adjudicate#choosing-the-model-endpoint)
+for the config table. `STYLEFIX_LLM_*` no longer configures proofix; use the
+shared file or `ADJUDICATE_LLM_*` to set both tools at once.
+
+Accept lists: `--accept FILE`, `~/.config/proofix/accept.txt`,
+`./.proofix/accept.txt`, and stylefix's `~/.config/stylefix/accept.txt` and
+`./.stylefix/accept.txt` are all honoured for spelling.
+
+## Output
+
+`<name>.proofed.md`, a report next to it, and with `--changes` a log on
+stderr: every edit with its line, before and after, context and how it was
+decided; the comma corrections with the model's reasons; comma suggestions
+the guard rejected, with what the model wanted; notes on faults the model
+noticed but is not allowed to fix (comma splices, agreement errors, a
+missing closing quote); and LanguageTool matches with no fix.
+
+## License
+
+MIT (see `LICENSE`).
+
+## Development
+
+```
+uv sync
+uv run pytest   # LanguageTool is replayed from a fixture; the model is a stub
+```

proofix-0.5.0/examples/typos.md

@@ -0,0 +1,9 @@
+# Test
+
+Teh committee recieved the the report , and its findings were definately clear.However the chair,who was late disagreed. We need to seperate the issues;the budget ,the timeline and the staff. "This is fine" she said . The programme was analysed by three seperate teams..
+
+The committee, decided to postpone the vote. The report, which was published in May was ignored. It was late, we went home anyway. See `recieved` in code and [teh link](http://x.y/teh).
+
+Third-party auditors and third-party monitors are needed. Every third party risk assessor must be third-party certified.
+
+Monitor, detect and correct **unsanctioned actions** — see <config>.

proofix-0.5.0/man/proofix.1

@@ -0,0 +1,235 @@
+.TH PROOFIX 1 "September 2026" "proofix 0.5.0" "User Commands"
+.SH NAME
+proofix \- fix typos and punctuation in Markdown, under audit
+.SH SYNOPSIS
+.B proofix
+.I input.md
+.RI [ options ]
+.br
+.B proofix
+.RB [ \-\-setup " | " \-\-check\-endpoint ]
+.SH DESCRIPTION
+.B proofix
+corrects typos and punctuation in a Markdown file. Every change is one
+bounded, logged, reasoned edit; the model never rewrites prose. Run it
+after
+.BR stylefix (1).
+.PP
+Five tiers, numbered as in \-\-help and the README:
+.TP
+.B 0 hygiene
+Text that renders fine but is not what it looks like. HTML entities that
+Markdown can carry as plain characters (  is a space, " a quote,
+— a dash) are decoded; entities that would change Markdown's parsing
+(<, >, &) or carry meaning ( ) are left alone and reported.
+Zero-width spaces, byte-order marks, soft hyphens and control characters
+are removed. Windows line endings and decomposed accents are normalised
+first. Every change is logged.
+.TP
+.B 1 mechanical
+A space before a comma or period, a missing space after one, doubled
+punctuation, doubled words, known misspellings. Found by LanguageTool's
+single-answer rules and the typos tool; applied outright.
+.TP
+.B 2 adjudicated
+Unknown words and grammar rules with candidate fixes. LanguageTool
+proposes; a language model picks one or KEEP from the sentence and the rule's
+message.
+.TP
+.B 3 compounds and consistency
+How a compound is written: closed, hyphenated or open ("cyberattack",
+"non-profit", "long term"), and terms the document capitalises two ways.
+Candidates come from the dictionaries: an open or hyphenated pair whose
+closed form is a word, a non-word that splits into two words, or anything
+the document writes two ways. The model chooses closed, hyphenated, open
+or KEEP, told which dictionary rules (Merriam-Webster for US, Oxford for
+UK) and that a compound modifier before a noun is hyphenated while a noun
+phrase is open, so "a third party" survives and "third party assessors"
+does not.
+.TP
+.B 4 commas
+Comma placement, which no rule engine detects. The model returns the
+sentence with commas corrected; a diff guard admits only insertions and
+deletions of commas and rejects anything else. Comma splices and other
+faults the model notices are reported as notes, not changed. Serial
+commas are left to stylefix's style guide.
+.PP
+Code, link targets, URLs, HTML and front matter are never touched.
+LanguageTool runs twice: mechanical fixes first, then judgement calls on
+the cleaned text.
+.SH OPTIONS
+.TP
+.BI \-o ", " \-\-output " FILE"
+Default: the input name with .proofed before the extension.
+.TP
+.BR \-i ", " \-\-in\-place
+Overwrite the input.
+.TP
+.BR \-\-target " {us|uk}"
+Variety the document is written in. Default us.
+.TP
+.BI \-\-accept " FILE"
+Extra words never flagged as misspelled. ~/.config/proofix/accept.txt,
+\&./.proofix/accept.txt and stylefix's accept lists are also honoured.
+.TP
+.B \-\-no\-lt
+Skip LanguageTool: its tier 1 fixes (typos still runs) and all of tier 2.
+.TP
+.BR \-\-lt\-level " {default|picky}"
+LanguageTool rule level.
+.TP
+.B \-\-no\-typos
+Skip the typos pre-pass.
+.TP
+.B \-\-no\-hygiene
+Skip the hygiene tier.
+.TP
+.B \-\-no\-consistency
+Skip the compounds and consistency tier.
+.TP
+.BI \-\-style " GUIDE"
+Style guide, used only for its hyphenation habit: ap hyphenates less.
+.TP
+.BR \-\-commas " {gated|all|none}"
+Which sentences the comma tier sends to the model. gated (default): those
+with a comma, an introductory opener, a clause trigger, or clauses joined
+by a conjunction. all: every sentence. none: skip the tier.
+.TP
+.B \-\-no\-commas
+Same as
+.BR "\-\-commas none" .
+.TP
+.BI \-\-max\-sentences " N"
+Cap on sentences sent to the comma tier.
+.TP
+.BR \-\-optional\-commas " {leave|add}"
+Commas that are optional by convention: leave as written (default) or
+add.
+.TP
+.BR \-\-llm " {auto|ollama|none}"
+.B auto
+(default) uses the endpoint from, highest first, the flags below,
+.BR PROOFIX_LLM_* ,
+.IR ~/.config/proofix/config.toml ,
+.B ADJUDICATE_LLM_*
+and
+.IR ~/.config/adjudicate/config.toml ,
+or else a local Ollama with a model pulled, or else no model.
+.B ollama
+uses the local Ollama server only, ignoring configured endpoints.
+.B none
+uses no model: tier 2's fixes are listed for review, not applied, tier 3
+is skipped and sentences are not checked for commas; tiers 0 and 1 still
+apply.
+.TP
+.BI \-\-url " URL"
+Any OpenAI-compatible base URL ending in /v1. Overrides every configured url.
+A \-\-url or PROOFIX_LLM_URL drops keys set in lower layers; set
+PROOFIX_LLM_KEY (or \fBapi_key_env\fR in the same config file) alongside it.
+.TP
+.BI \-\-model " NAME"
+Model name at the endpoint. If no layer sets one, the server's first listed model.
+.TP
+.BI \-\-timeout " SEC"
+Seconds per model request, a positive number. Default 120, or
+\fBtimeout\fR in config.toml.
+.TP
+.BI \-\-min\-confidence " X"
+Decisions below this are not applied. Default 0.8.
+.TP
+.BI \-\-parallel " N"
+Concurrent model requests. Default 4.
+.TP
+.BI \-\-cache " FILE" ", " \-\-no\-cache
+Decision cache, default .proofix/cache.json (commas in commas.json next to it).
+.TP
+.BI \-\-report " FILE" ", " \-\-no\-report
+Markdown report, default <output>.report.md.
+.TP
+.B \-\-dry\-run
+Print a diff, write nothing.
+.TP
+.B \-\-changes
+Print every change to standard error as it is made.
+.TP
+.B \-\-setup
+Ask where the model is (local Ollama, a hosted OpenAI-compatible API, or a
+self-hosted server), test it, and save the answer as the
+.B [llm]
+table of
+.I ~/.config/adjudicate/config.toml
+(shared with stylefix) or
+.IR ~/.config/proofix/config.toml .
+An existing table is shown and replaced only on confirmation, after a
+backup to
+.IR config.toml.bak .
+Needs a terminal. Ends by running the check below.
+.TP
+.B \-\-check\-endpoint
+Print the endpoint proofix would use, one line per setting with the layer
+it came from (a key is never shown), then list the server's models and
+send one small request. Honours
+.BR \-\-llm ", " \-\-url ", " \-\-model " and " \-\-timeout .
+.TP
+.BR \-v ", " \-\-verbose
+Report model batches on standard error.
+.TP
+.B \-\-version
+Print the version and exit.
+.TP
+.BR \-h ", " \-\-help
+Print the usage summary and exit.
+.SH PERFORMANCE
+On a 20-page document (8,000 words) with a local 27B model and 8 parallel
+requests: LanguageTool 4.5 s per pass; the comma tier 19 s for the 260
+sentences that pass the gate; about a minute in all. Linear in length.
+Decisions are cached by sentence.
+.SH ENVIRONMENT
+.TP
+.BR PROOFIX_LLM_URL ", " PROOFIX_LLM_MODEL ", " PROOFIX_LLM_KEY
+Endpoint, model and API key for proofix; below the flags, above the config
+files.
+.TP
+.BR ADJUDICATE_LLM_URL ", " ADJUDICATE_LLM_MODEL ", " ADJUDICATE_LLM_KEY
+The same, shared with stylefix; below
+.I ~/.config/proofix/config.toml
+and above
+.IR ~/.config/adjudicate/config.toml .
+.TP
+.B OLLAMA_HOST
+Ollama base URL. Default http://localhost:11434.
+.SH FILES
+.TP
+.I ~/.config/proofix/config.toml
+.TQ
+.I ~/.config/adjudicate/config.toml
+Table
+.B [llm]
+with keys
+.BR url ", " model ", " api_key " or " api_key_env ", " timeout ", " thinking_switch .
+The first applies to proofix only; the second is shared with stylefix.
+.TP
+.IR ~/.config/proofix/accept.txt ", " ~/.config/stylefix/accept.txt ", " .stylefix/accept.txt ", " .proofix/accept.txt
+Words never flagged as misspelled, one per line.
+.SH EXIT STATUS
+.TP
+.B 0
+Finished. For
+.BR \-\-check\-endpoint " and " \-\-setup :
+the endpoint answers.
+.TP
+.B 1
+.BR \-\-check\-endpoint " or " \-\-setup :
+no endpoint, or it does not answer; or setup was cancelled or declined.
+.TP
+.B 2
+Input file missing, LanguageTool failed, or an invalid endpoint
+configuration (the message names the file and key). For
+.BR \-\-setup :
+standard input is not a terminal.
+.SH SEE ALSO
+.BR stylefix (1),
+.BR languagetool (1),
+.BR typos (1).
+.PP
+Full documentation: https://github.com/AndrewBroz/proofix

proofix-0.5.0/proofix/__init__.py

@@ -0,0 +1,3 @@
+"""proofix: typos and punctuation, fixed under audit."""
+
+__version__ = "0.5.0"