westminster-standards-cli 0.1.0__tar.gz

westminster_standards_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Westminster Standards CLI contributors
+
+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.

westminster_standards_cli-0.1.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: westminster-standards-cli
+Version: 0.1.0
+Summary: A command line reader, searcher, and quiz tool for the Westminster Standards.
+Author: Westminster Standards CLI contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/normanormata/westminster_cli
+Project-URL: Repository, https://github.com/normanormata/westminster_cli
+Project-URL: Issues, https://github.com/normanormata/westminster_cli/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prompt_toolkit<4.0,>=3.0
+Dynamic: license-file
+
+# Westminster Standards CLI
+
+A small command line tool for reading, searching, and quizzing yourself on the Westminster Standards.
+
+The CLI ships with the Orthodox Presbyterian Church constitutional text for:
+
+- Westminster Confession of Faith (`wcf`)
+- Westminster Larger Catechism (`wlc`)
+- Westminster Shorter Catechism (`wsc`)
+
+The data is derived from the OPC pages linked from <https://opc.org/confessions.html>. The constitutional text is the default; the 2025 Modern English Study Version (MESV) is also bundled and available via `-m`/`--mesv` and `--compare`. Note the OPC preface: the MESV is a study aid and carries no constitutional authority.
+
+The bundled corpus lives in `src/westminster_cli/data/standards.json`. The importer in `scripts/build_opc_corpus.py` can rebuild it from downloaded OPC HTML.
+
+## Installation
+
+You need Python 3.9+ and [uv](https://docs.astral.sh/uv/) installed.
+
+Install `uv` if you do not already have it:
+
+```sh
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+To try the CLI from a fresh clone:
+
+```sh
+git clone https://github.com/normanormata/westminster_cli.git
+cd westminster_cli
+uv run ws
+```
+
+That opens the interactive terminal session. You can also run one-shot commands
+without installing globally:
+
+```sh
+uv run ws stats
+uv run ws wcf 1
+uv run ws wsc 1 --question
+```
+
+To install `ws` as a command you can run from anywhere:
+
+```sh
+uv tool install git+https://github.com/normanormata/westminster_cli.git
+```
+
+Then run:
+
+```sh
+ws
+ws stats
+ws wcf 1
+```
+
+If you cloned the repo and want your local edits to take effect while you work
+on the CLI, install it in editable mode from inside the project folder:
+
+```sh
+uv tool install -e .
+```
+
+## Run locally
+
+```sh
+uv run ws
+uv run ws --help
+```
+
+Running `ws` with no arguments opens an interactive terminal session. Inside it,
+type `/` to see live slash-command suggestions, use arrow keys to select a
+command template, run commands without the `ws` prefix, and type `exit` to quit.
+Plain commands such as `wcf`, `search`, and `stats` also complete while typing.
+Completion is context-aware: after a document id (`wsc `) it suggests references,
+and after a reference it suggests `--question`/`--answer`. Command history persists
+across sessions, and a bottom toolbar shows quick hints and corpus counts.
+
+Use `quiz` for an interactive flashcard session: it shows a question, waits for
+Enter to reveal the answer, records whether you got it, and prints a running score.
+Type `s` to skip a card or `q` to stop early. Pass a document id and question
+count to shape the session, e.g. `ws quiz wlc 20` (defaults: `wsc`, 10 questions).
+
+Pass `-p`/`--proofs` to any reading command (`ws wsc 1 -p`, `ws wcf 1.1 -p`,
+`ws wcf 1 -p`) to show the OPC scripture proof texts beneath the text,
+lettered to match the printed edition. It combines with `-q`/`-a`, and `/p wsc 1`
+works as a slash alias.
+
+Pass `-m`/`--mesv` to read the 2025 Modern English Study Version instead
+(`ws wsc 1 -m`, `ws wcf 1.1 -m`, `/m wsc 1`), or `--compare` to see the
+constitutional and MESV texts together. `-m` combines with `-q`/`-a`
+(modern question or answer only) and `-p`.
+
+UV creates and syncs the project environment automatically from `pyproject.toml`
+and `uv.lock`.
+
+The repo also includes direct wrappers if you want to run without syncing a UV
+environment:
+
+```sh
+./ws --help
+./westminster --help
+./wsc show wsc 1
+```
+
+## Commands
+
+```sh
+uv run ws list
+uv run ws list wsc
+uv run ws wsc 1
+uv run ws wsc 1 --question
+uv run ws wsc 1 --answer
+uv run ws wsc 1 --proofs
+uv run ws wsc 1 --mesv
+uv run ws wsc 1 --compare
+uv run ws wcf 1
+uv run ws wcf 1.1
+uv run ws wcf 1.1 -p
+uv run ws wcf 1.1 -m
+uv run ws search "chief end"
+uv run ws quiz
+uv run ws quiz wlc 20
+uv run ws stats
+uv run ws sources
+uv run ws clear
+```
+
+Slash command discovery and aliases:
+
+```sh
+uv run ws /
+uv run ws /wcf 1
+uv run ws /wsc 1 --question
+uv run ws /q wsc 1
+uv run ws /a wlc 1
+uv run ws /p wsc 1
+uv run ws /m wsc 1
+uv run ws /stats
+uv run ws /clear
+```
+
+The explicit `show` command still works:
+
+```sh
+uv run ws show wcf 1
+uv run ws show wsc 1
+```
+
+The full command name still works:
+
+```sh
+uv run westminster stats
+```
+
+After installing the tool, both names are available:
+
+```sh
+ws stats
+westminster stats
+wsc show wsc 1
+```
+
+## Test
+
+```sh
+uv run python -m unittest discover -s tests
+```
+
+## Rebuild the OPC corpus
+
+```sh
+curl -L https://opc.org/wcf.html -o /tmp/opc-wcf.html
+curl -L https://opc.org/lc.html -o /tmp/opc-lc.html
+curl -L https://opc.org/sc.html -o /tmp/opc-sc.html
+python3 scripts/build_opc_corpus.py /tmp/opc-wcf.html /tmp/opc-lc.html /tmp/opc-sc.html
+```
+
+## Rebuild the scripture proofs
+
+The proof references come from the OPC "with Scripture proofs" PDFs linked from
+<https://opc.org/confessions.html>. After rebuilding the corpus, re-merge them:
+
+```sh
+curl -L https://opc.org/documents/CFLayout.pdf -o /tmp/CFLayout.pdf
+curl -L https://opc.org/documents/LCLayout.pdf -o /tmp/LCLayout.pdf
+curl -L https://opc.org/documents/SCLayout.pdf -o /tmp/SCLayout.pdf
+uv run python scripts/add_scripture_proofs.py /tmp/CFLayout.pdf /tmp/LCLayout.pdf /tmp/SCLayout.pdf
+```
+
+The script validates that every superscript proof marker in the body text pairs
+with a lettered footnote and reports per-document counts before writing.
+
+## Rebuild the MESV text
+
+The 2025 Modern English Study Version comes from the OPC PDFs linked from
+<https://opc.org/confessions.html>:
+
+```sh
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Confession_of_Faith.pdf -o /tmp/mesv_cf.pdf
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Larger_Catechism.pdf -o /tmp/mesv_lc.pdf
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Shorter_Catechism.pdf -o /tmp/mesv_sc.pdf
+uv run python scripts/add_mesv.py /tmp/mesv_cf.pdf /tmp/mesv_lc.pdf /tmp/mesv_sc.pdf
+```
+
+The script validates that the MESV refs exactly match the constitutional
+corpus (33 chapters / 171 sections, 196 and 107 questions) before writing.
+
+## Data format
+
+Each document has an id, title, short name, and entries:
+
+```json
+{
+  "id": "wsc",
+  "title": "Westminster Shorter Catechism",
+  "short_title": "Shorter Catechism",
+  "source": "Orthodox Presbyterian Church constitutional text",
+  "source_url": "https://opc.org/sc.html",
+  "entries": [
+    {
+      "ref": "1",
+      "kind": "qa",
+      "question": "What is the chief end of man?",
+      "answer": "Man's chief end is to glorify God, and to enjoy him forever."
+    }
+  ]
+}
+```
+
+For confession paragraphs, use `kind: "section"` with `heading` and `text`.
+
+Entries may also carry an optional `proofs` list of scripture proof references,
+each with the OPC footnote `letter` and its `references`:
+
+```json
+"proofs": [
+  { "letter": "a", "references": ["Ps. 86:9", "Rom. 11:36"] }
+]
+```
+
+Entries may also carry the 2025 MESV text in parallel fields:
+`question_mesv`/`answer_mesv` for catechism entries, and
+`text_mesv`/`heading_mesv` for confession sections.

westminster_standards_cli-0.1.0/README.md

@@ -0,0 +1,243 @@
+# Westminster Standards CLI
+
+A small command line tool for reading, searching, and quizzing yourself on the Westminster Standards.
+
+The CLI ships with the Orthodox Presbyterian Church constitutional text for:
+
+- Westminster Confession of Faith (`wcf`)
+- Westminster Larger Catechism (`wlc`)
+- Westminster Shorter Catechism (`wsc`)
+
+The data is derived from the OPC pages linked from <https://opc.org/confessions.html>. The constitutional text is the default; the 2025 Modern English Study Version (MESV) is also bundled and available via `-m`/`--mesv` and `--compare`. Note the OPC preface: the MESV is a study aid and carries no constitutional authority.
+
+The bundled corpus lives in `src/westminster_cli/data/standards.json`. The importer in `scripts/build_opc_corpus.py` can rebuild it from downloaded OPC HTML.
+
+## Installation
+
+You need Python 3.9+ and [uv](https://docs.astral.sh/uv/) installed.
+
+Install `uv` if you do not already have it:
+
+```sh
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+To try the CLI from a fresh clone:
+
+```sh
+git clone https://github.com/normanormata/westminster_cli.git
+cd westminster_cli
+uv run ws
+```
+
+That opens the interactive terminal session. You can also run one-shot commands
+without installing globally:
+
+```sh
+uv run ws stats
+uv run ws wcf 1
+uv run ws wsc 1 --question
+```
+
+To install `ws` as a command you can run from anywhere:
+
+```sh
+uv tool install git+https://github.com/normanormata/westminster_cli.git
+```
+
+Then run:
+
+```sh
+ws
+ws stats
+ws wcf 1
+```
+
+If you cloned the repo and want your local edits to take effect while you work
+on the CLI, install it in editable mode from inside the project folder:
+
+```sh
+uv tool install -e .
+```
+
+## Run locally
+
+```sh
+uv run ws
+uv run ws --help
+```
+
+Running `ws` with no arguments opens an interactive terminal session. Inside it,
+type `/` to see live slash-command suggestions, use arrow keys to select a
+command template, run commands without the `ws` prefix, and type `exit` to quit.
+Plain commands such as `wcf`, `search`, and `stats` also complete while typing.
+Completion is context-aware: after a document id (`wsc `) it suggests references,
+and after a reference it suggests `--question`/`--answer`. Command history persists
+across sessions, and a bottom toolbar shows quick hints and corpus counts.
+
+Use `quiz` for an interactive flashcard session: it shows a question, waits for
+Enter to reveal the answer, records whether you got it, and prints a running score.
+Type `s` to skip a card or `q` to stop early. Pass a document id and question
+count to shape the session, e.g. `ws quiz wlc 20` (defaults: `wsc`, 10 questions).
+
+Pass `-p`/`--proofs` to any reading command (`ws wsc 1 -p`, `ws wcf 1.1 -p`,
+`ws wcf 1 -p`) to show the OPC scripture proof texts beneath the text,
+lettered to match the printed edition. It combines with `-q`/`-a`, and `/p wsc 1`
+works as a slash alias.
+
+Pass `-m`/`--mesv` to read the 2025 Modern English Study Version instead
+(`ws wsc 1 -m`, `ws wcf 1.1 -m`, `/m wsc 1`), or `--compare` to see the
+constitutional and MESV texts together. `-m` combines with `-q`/`-a`
+(modern question or answer only) and `-p`.
+
+UV creates and syncs the project environment automatically from `pyproject.toml`
+and `uv.lock`.
+
+The repo also includes direct wrappers if you want to run without syncing a UV
+environment:
+
+```sh
+./ws --help
+./westminster --help
+./wsc show wsc 1
+```
+
+## Commands
+
+```sh
+uv run ws list
+uv run ws list wsc
+uv run ws wsc 1
+uv run ws wsc 1 --question
+uv run ws wsc 1 --answer
+uv run ws wsc 1 --proofs
+uv run ws wsc 1 --mesv
+uv run ws wsc 1 --compare
+uv run ws wcf 1
+uv run ws wcf 1.1
+uv run ws wcf 1.1 -p
+uv run ws wcf 1.1 -m
+uv run ws search "chief end"
+uv run ws quiz
+uv run ws quiz wlc 20
+uv run ws stats
+uv run ws sources
+uv run ws clear
+```
+
+Slash command discovery and aliases:
+
+```sh
+uv run ws /
+uv run ws /wcf 1
+uv run ws /wsc 1 --question
+uv run ws /q wsc 1
+uv run ws /a wlc 1
+uv run ws /p wsc 1
+uv run ws /m wsc 1
+uv run ws /stats
+uv run ws /clear
+```
+
+The explicit `show` command still works:
+
+```sh
+uv run ws show wcf 1
+uv run ws show wsc 1
+```
+
+The full command name still works:
+
+```sh
+uv run westminster stats
+```
+
+After installing the tool, both names are available:
+
+```sh
+ws stats
+westminster stats
+wsc show wsc 1
+```
+
+## Test
+
+```sh
+uv run python -m unittest discover -s tests
+```
+
+## Rebuild the OPC corpus
+
+```sh
+curl -L https://opc.org/wcf.html -o /tmp/opc-wcf.html
+curl -L https://opc.org/lc.html -o /tmp/opc-lc.html
+curl -L https://opc.org/sc.html -o /tmp/opc-sc.html
+python3 scripts/build_opc_corpus.py /tmp/opc-wcf.html /tmp/opc-lc.html /tmp/opc-sc.html
+```
+
+## Rebuild the scripture proofs
+
+The proof references come from the OPC "with Scripture proofs" PDFs linked from
+<https://opc.org/confessions.html>. After rebuilding the corpus, re-merge them:
+
+```sh
+curl -L https://opc.org/documents/CFLayout.pdf -o /tmp/CFLayout.pdf
+curl -L https://opc.org/documents/LCLayout.pdf -o /tmp/LCLayout.pdf
+curl -L https://opc.org/documents/SCLayout.pdf -o /tmp/SCLayout.pdf
+uv run python scripts/add_scripture_proofs.py /tmp/CFLayout.pdf /tmp/LCLayout.pdf /tmp/SCLayout.pdf
+```
+
+The script validates that every superscript proof marker in the body text pairs
+with a lettered footnote and reports per-document counts before writing.
+
+## Rebuild the MESV text
+
+The 2025 Modern English Study Version comes from the OPC PDFs linked from
+<https://opc.org/confessions.html>:
+
+```sh
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Confession_of_Faith.pdf -o /tmp/mesv_cf.pdf
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Larger_Catechism.pdf -o /tmp/mesv_lc.pdf
+curl -L https://opc.org/documents/2025_Modern_English_Study_Version_of_The_Shorter_Catechism.pdf -o /tmp/mesv_sc.pdf
+uv run python scripts/add_mesv.py /tmp/mesv_cf.pdf /tmp/mesv_lc.pdf /tmp/mesv_sc.pdf
+```
+
+The script validates that the MESV refs exactly match the constitutional
+corpus (33 chapters / 171 sections, 196 and 107 questions) before writing.
+
+## Data format
+
+Each document has an id, title, short name, and entries:
+
+```json
+{
+  "id": "wsc",
+  "title": "Westminster Shorter Catechism",
+  "short_title": "Shorter Catechism",
+  "source": "Orthodox Presbyterian Church constitutional text",
+  "source_url": "https://opc.org/sc.html",
+  "entries": [
+    {
+      "ref": "1",
+      "kind": "qa",
+      "question": "What is the chief end of man?",
+      "answer": "Man's chief end is to glorify God, and to enjoy him forever."
+    }
+  ]
+}
+```
+
+For confession paragraphs, use `kind: "section"` with `heading` and `text`.
+
+Entries may also carry an optional `proofs` list of scripture proof references,
+each with the OPC footnote `letter` and its `references`:
+
+```json
+"proofs": [
+  { "letter": "a", "references": ["Ps. 86:9", "Rom. 11:36"] }
+]
+```
+
+Entries may also carry the 2025 MESV text in parallel fields:
+`question_mesv`/`answer_mesv` for catechism entries, and
+`text_mesv`/`heading_mesv` for confession sections.

westminster_standards_cli-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "westminster-standards-cli"
+version = "0.1.0"
+description = "A command line reader, searcher, and quiz tool for the Westminster Standards."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [{ name = "Westminster Standards CLI contributors" }]
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = ["prompt_toolkit>=3.0,<4.0"]
+
+[project.urls]
+Homepage = "https://github.com/normanormata/westminster_cli"
+Repository = "https://github.com/normanormata/westminster_cli"
+Issues = "https://github.com/normanormata/westminster_cli/issues"
+
+[project.scripts]
+westminster = "westminster_cli.cli:main"
+ws = "westminster_cli.cli:main"
+wsc = "westminster_cli.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+westminster_cli = ["data/*.json"]
+
+[dependency-groups]
+dev = [
+    "pymupdf>=1.26.5",
+    "pytest>=8.4.2",
+]

westminster_standards_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

westminster_standards_cli-0.1.0/src/westminster_cli/__init__.py

@@ -0,0 +1,5 @@
+"""Westminster Standards command line package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

westminster_standards_cli-0.1.0/src/westminster_cli/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())