ctrl-kd 4.0.1__tar.gz → 4.5.1__tar.gz

ctrl_kd-4.5.1/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: ctrl-kd
+Version: 4.5.1
+Summary: Convert WordStar 4-7 documents and print-to-disk files to text, Markdown, HTML, RTF, or PDF. ^KD: save and done.
+Author: Jon Michaels
+License: MIT
+Project-URL: Homepage, https://github.com/jonmichaels/ctrl-kd
+Keywords: wordstar,converter,retrocomputing,archive,dos
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Processing :: Filters
+Classifier: Topic :: System :: Archiving
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+```
+        __       __      __       __
+  _____/ /______/ /     / /______/ /
+ / ___/ __/ ___/ /_____/ //_/ __  /
+/ /__/ /_/ /  / /_____/ ,< / /_/ /
+\___/\__/_/  /_/     /_/|_|\__,_/
+```
+# ctrl-kd
+
+Convert WordStar for DOS v4-v7 files to modern formats. **^KD: save and done.**
+
+`ctrl-kd` reads WordStar for DOS documents, and WordStar print stream files, 
+and writes plain text, Markdown, HTML, RTF, or PDF (set on a viewer's 
+built-in base-14 fonts — no dependencies, nothing embedded, the page as it 
+would have printed: printed mode follows the document's own font blocks and 
+its own layout arithmetic, while modern mode is the same document reflowed 
+for today: its fonts, headers, and footnotes all carried.
+
+```console
+$ ctrl-kd ESSAY.WS                      # -> ESSAY.rtf: modern reflow, the
+                                        #    document's own fonts carried
+$ ctrl-kd --mode printed LETTER.WS      # -> LETTER.pdf: the 1990 facsimile
+$ ctrl-kd ESSAY.WS -t md                # modern markdown instead
+$ ctrl-kd ESSAY.WS -t html -t rtf       # multiple formats
+$ ctrl-kd --page-settings sawyer X.WS   # a known machine's page defaults
+$ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
+$ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
+$ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
+$ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+```
+
+## Modes
+
+* `--mode modern` (default; bare runs produce RTF): the document brought to a
+  modern audience — reflowed, its own fonts and styles carried, footnotes at
+  the page bottom, gaps the file never specified filled with today's
+  conventions (a comfortable serif at reading size, one-inch margins).
+* `--mode printed` (bare runs produce PDF): every line as laid out, on the
+  era's own page — how it came off the printer. Gaps are filled with 1990's
+  conventions instead; `--page-settings` supplies a particular machine's.
+
+More information: **[FAQ.md](FAQ.md)**, and **[ERAS.md](ERAS.md)**.
+
+## Install
+
+```console
+$ brew install jonmichaels/tap/ctrl-kd     # macOS / Linuxbrew
+$ pipx install ctrl-kd                     # or: pip install ctrl-kd
+```
+Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd/releases/latest/download/ctrl-kd-windows-x86_64.zip)
+
+Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
+
+## Adding an output format
+
+An output format is one function over the parsed document — register it with the
+`@ctrlkd.emitter` decorator, or ship it as a pip-installable plugin via the
+`ctrlkd.emitters` entry-point group and it appears in the CLI automatically.
+**[EXTENDING.md](EXTENDING.md)** has the IR contract, a complete worked example
+(BBCode in ~40 lines), and a checklist.
+
+## Siblings
+
+**[Soft Return](https://github.com/jonmichaels/soft-return)** — macOS viewer and converter plus QuickLook extension.
+Includes a Swift command line utility.
+
+## Lineage
+
+I wanted to be able to see the 70-some WordStar 4 files I had from junior high 
+and high school. In about an hour and half my agent had my files looking 
+pretty good. And then I fell down the research rabbit hole...
+
+`ctrl-kd` wouldn't have been possible without the tools and documentation that 
+kept WordStar readable: Yohanes Nugroho's WS-CON, Michael Petrie's English port, 
+the `wsconvert`project, Robert J. Sawyer's WordStar archive, and the WordStar 
+format documentation community. 
+
+My own test files are personal and are not distributed — this repo's tests use 
+synthetic fixtures and some public domain docs I retyped in WordStar 4 and 
+WordStar 7 in DOSBox-X, plus Robert J. Sawyer's public WS7 archive (opt-in, 
+`pytest -m sawyer`; see `tests/SAWYER-CORPUS.md`) you can run your own tests
+against that if you have a copy: download the archive, point
+`CTRLKD_SAWYER_ARCHIVE` at its top-level directory (the one holding
+`CONVERT.WS`, `INSET/`, `ARTICLES/`), and verify the path before arming —
+`tests/SAWYER-CORPUS.md` has a one-line smoke check. A `CTRLKD_PRIVATE_CORPUS`
+variable also exists, for my own private regression fixtures — it has no
+effect unless you're me.
+
+## Credits
+
+Written by Jon Michaels — whose 1987–1992 WordStar files, and the need to read
+them again, are the reason this exists — with Athena (Claude, Anthropic) as
+co-author.

ctrl_kd-4.5.1/README.md

@@ -0,0 +1,93 @@
+```
+        __       __      __       __
+  _____/ /______/ /     / /______/ /
+ / ___/ __/ ___/ /_____/ //_/ __  /
+/ /__/ /_/ /  / /_____/ ,< / /_/ /
+\___/\__/_/  /_/     /_/|_|\__,_/
+```
+# ctrl-kd
+
+Convert WordStar for DOS v4-v7 files to modern formats. **^KD: save and done.**
+
+`ctrl-kd` reads WordStar for DOS documents, and WordStar print stream files, 
+and writes plain text, Markdown, HTML, RTF, or PDF (set on a viewer's 
+built-in base-14 fonts — no dependencies, nothing embedded, the page as it 
+would have printed: printed mode follows the document's own font blocks and 
+its own layout arithmetic, while modern mode is the same document reflowed 
+for today: its fonts, headers, and footnotes all carried.
+
+```console
+$ ctrl-kd ESSAY.WS                      # -> ESSAY.rtf: modern reflow, the
+                                        #    document's own fonts carried
+$ ctrl-kd --mode printed LETTER.WS      # -> LETTER.pdf: the 1990 facsimile
+$ ctrl-kd ESSAY.WS -t md                # modern markdown instead
+$ ctrl-kd ESSAY.WS -t html -t rtf       # multiple formats
+$ ctrl-kd --page-settings sawyer X.WS   # a known machine's page defaults
+$ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
+$ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
+$ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
+$ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+```
+
+## Modes
+
+* `--mode modern` (default; bare runs produce RTF): the document brought to a
+  modern audience — reflowed, its own fonts and styles carried, footnotes at
+  the page bottom, gaps the file never specified filled with today's
+  conventions (a comfortable serif at reading size, one-inch margins).
+* `--mode printed` (bare runs produce PDF): every line as laid out, on the
+  era's own page — how it came off the printer. Gaps are filled with 1990's
+  conventions instead; `--page-settings` supplies a particular machine's.
+
+More information: **[FAQ.md](FAQ.md)**, and **[ERAS.md](ERAS.md)**.
+
+## Install
+
+```console
+$ brew install jonmichaels/tap/ctrl-kd     # macOS / Linuxbrew
+$ pipx install ctrl-kd                     # or: pip install ctrl-kd
+```
+Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd/releases/latest/download/ctrl-kd-windows-x86_64.zip)
+
+Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
+
+## Adding an output format
+
+An output format is one function over the parsed document — register it with the
+`@ctrlkd.emitter` decorator, or ship it as a pip-installable plugin via the
+`ctrlkd.emitters` entry-point group and it appears in the CLI automatically.
+**[EXTENDING.md](EXTENDING.md)** has the IR contract, a complete worked example
+(BBCode in ~40 lines), and a checklist.
+
+## Siblings
+
+**[Soft Return](https://github.com/jonmichaels/soft-return)** — macOS viewer and converter plus QuickLook extension.
+Includes a Swift command line utility.
+
+## Lineage
+
+I wanted to be able to see the 70-some WordStar 4 files I had from junior high 
+and high school. In about an hour and half my agent had my files looking 
+pretty good. And then I fell down the research rabbit hole...
+
+`ctrl-kd` wouldn't have been possible without the tools and documentation that 
+kept WordStar readable: Yohanes Nugroho's WS-CON, Michael Petrie's English port, 
+the `wsconvert`project, Robert J. Sawyer's WordStar archive, and the WordStar 
+format documentation community. 
+
+My own test files are personal and are not distributed — this repo's tests use 
+synthetic fixtures and some public domain docs I retyped in WordStar 4 and 
+WordStar 7 in DOSBox-X, plus Robert J. Sawyer's public WS7 archive (opt-in, 
+`pytest -m sawyer`; see `tests/SAWYER-CORPUS.md`) you can run your own tests
+against that if you have a copy: download the archive, point
+`CTRLKD_SAWYER_ARCHIVE` at its top-level directory (the one holding
+`CONVERT.WS`, `INSET/`, `ARTICLES/`), and verify the path before arming —
+`tests/SAWYER-CORPUS.md` has a one-line smoke check. A `CTRLKD_PRIVATE_CORPUS`
+variable also exists, for my own private regression fixtures — it has no
+effect unless you're me.
+
+## Credits
+
+Written by Jon Michaels — whose 1987–1992 WordStar files, and the need to read
+them again, are the reason this exists — with Athena (Claude, Anthropic) as
+co-author.

ctrl_kd-4.5.1/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ctrl-kd"
+dynamic = ["version"]
+description = "Convert WordStar 4-7 documents and print-to-disk files to text, Markdown, HTML, RTF, or PDF. ^KD: save and done."
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Jon Michaels"}]
+requires-python = ">=3.9"
+keywords = ["wordstar", "converter", "retrocomputing", "archive", "dos"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Text Processing :: Filters",
+    "Topic :: System :: Archiving",
+]
+
+[project.urls]
+Homepage = "https://github.com/jonmichaels/ctrl-kd"
+
+[project.scripts]
+ctrl-kd = "ctrlkd.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+# single source of truth: src/ctrlkd/__init__.py __version__ -- the 4.0.0
+# release shipped with pyproject still saying 3.0.0 because the version
+# lived in two places and the bump hit one (2026-08-06); never again
+version = {attr = "ctrlkd.__version__"}
+
+[tool.setuptools.package-data]
+# The four bundled public-domain sample documents (see samples/README.md and
+# `ctrl-kd --samples DIR`) travel with the wheel/sdist as package data.
+ctrlkd = ["samples/*.WS"]
+
+[tool.pytest.ini_options]
+# Two-tier test architecture (K1, 2026-08-26; tier 3/private relocated out
+# of this public repo entirely -- see README). Bare `pytest` must run ONLY
+# tier 1 (tests/test_samples.py and every other test with no marker below)
+# -- green, complete, zero skips, no environment required. Tier 2 is
+# DESELECTED here, not skipped: it never even collects into the report, so
+# a bare run's summary line is an honest denominator.
+#
+# Arming (see tests/sawyer_fixture.py, conftest.py, tools/pcl_tolerance.py):
+#   sawyer   CTRLKD_SAWYER_ARCHIVE=/path
+#   pcl      CTRLKD_PRIVATE_CORPUS=/path (2026-09-05, planning #197)
+#   paper    CTRLKD_PRIVATE_CORPUS=/path (2026-09-06, planning #200; verdicts
+#            file path itself overridable with CTRLKD_PAPER_VERDICTS)
+#
+# tools/run-full-suite.sh overrides this filter (`-o addopts=""`) for an
+# armed run, where an unarmed gate FAILS instead of silently not running --
+# see that script's own header for why.
+testpaths = ["tests"]
+markers = [
+    "sawyer: opt-in tier 2 -- an explicit, committed list of documents from Robert J. Sawyer's public WordStar 7 archive (arm with CTRLKD_SAWYER_ARCHIVE)",
+    "pcl: opt-in -- coordinate-level fidelity gate against real WordStar 7 LaserJet PCL captures (arm with CTRLKD_PRIVATE_CORPUS); see tools/pcl_tolerance.py and tests/test_pcl_fidelity.py",
+    "paper: opt-in -- machine-readable verdicts for the 69 M479fdw paper-scan pages (arm with CTRLKD_PRIVATE_CORPUS); see tools/PAPER-VERDICTS.md and tests/test_paper_verdicts.py",
+]
+addopts = "-m \"not sawyer and not pcl and not paper\""

ctrl_kd-4.5.1/src/ctrl_kd.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: ctrl-kd
+Version: 4.5.1
+Summary: Convert WordStar 4-7 documents and print-to-disk files to text, Markdown, HTML, RTF, or PDF. ^KD: save and done.
+Author: Jon Michaels
+License: MIT
+Project-URL: Homepage, https://github.com/jonmichaels/ctrl-kd
+Keywords: wordstar,converter,retrocomputing,archive,dos
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Processing :: Filters
+Classifier: Topic :: System :: Archiving
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+```
+        __       __      __       __
+  _____/ /______/ /     / /______/ /
+ / ___/ __/ ___/ /_____/ //_/ __  /
+/ /__/ /_/ /  / /_____/ ,< / /_/ /
+\___/\__/_/  /_/     /_/|_|\__,_/
+```
+# ctrl-kd
+
+Convert WordStar for DOS v4-v7 files to modern formats. **^KD: save and done.**
+
+`ctrl-kd` reads WordStar for DOS documents, and WordStar print stream files, 
+and writes plain text, Markdown, HTML, RTF, or PDF (set on a viewer's 
+built-in base-14 fonts — no dependencies, nothing embedded, the page as it 
+would have printed: printed mode follows the document's own font blocks and 
+its own layout arithmetic, while modern mode is the same document reflowed 
+for today: its fonts, headers, and footnotes all carried.
+
+```console
+$ ctrl-kd ESSAY.WS                      # -> ESSAY.rtf: modern reflow, the
+                                        #    document's own fonts carried
+$ ctrl-kd --mode printed LETTER.WS      # -> LETTER.pdf: the 1990 facsimile
+$ ctrl-kd ESSAY.WS -t md                # modern markdown instead
+$ ctrl-kd ESSAY.WS -t html -t rtf       # multiple formats
+$ ctrl-kd --page-settings sawyer X.WS   # a known machine's page defaults
+$ ctrl-kd --diagnose MYSTERY.FIL        # what IS this file?
+$ ctrl-kd --comments MEMO.WS            # include the author's hidden comments
+$ ctrl-kd --no-notes PAPER.WS           # body text only, no notes
+$ ctrl-kd --samples DIR                 # write 4 bundled public-domain sample .WS files into DIR
+```
+
+## Modes
+
+* `--mode modern` (default; bare runs produce RTF): the document brought to a
+  modern audience — reflowed, its own fonts and styles carried, footnotes at
+  the page bottom, gaps the file never specified filled with today's
+  conventions (a comfortable serif at reading size, one-inch margins).
+* `--mode printed` (bare runs produce PDF): every line as laid out, on the
+  era's own page — how it came off the printer. Gaps are filled with 1990's
+  conventions instead; `--page-settings` supplies a particular machine's.
+
+More information: **[FAQ.md](FAQ.md)**, and **[ERAS.md](ERAS.md)**.
+
+## Install
+
+```console
+$ brew install jonmichaels/tap/ctrl-kd     # macOS / Linuxbrew
+$ pipx install ctrl-kd                     # or: pip install ctrl-kd
+```
+Download Windows x86_64: [Latest Version](https://github.com/jonmichaels/ctrl-kd/releases/latest/download/ctrl-kd-windows-x86_64.zip)
+
+Python ≥ 3.9, no dependencies. Library API: `ctrlkd.convert(data, to='html')`.
+
+## Adding an output format
+
+An output format is one function over the parsed document — register it with the
+`@ctrlkd.emitter` decorator, or ship it as a pip-installable plugin via the
+`ctrlkd.emitters` entry-point group and it appears in the CLI automatically.
+**[EXTENDING.md](EXTENDING.md)** has the IR contract, a complete worked example
+(BBCode in ~40 lines), and a checklist.
+
+## Siblings
+
+**[Soft Return](https://github.com/jonmichaels/soft-return)** — macOS viewer and converter plus QuickLook extension.
+Includes a Swift command line utility.
+
+## Lineage
+
+I wanted to be able to see the 70-some WordStar 4 files I had from junior high 
+and high school. In about an hour and half my agent had my files looking 
+pretty good. And then I fell down the research rabbit hole...
+
+`ctrl-kd` wouldn't have been possible without the tools and documentation that 
+kept WordStar readable: Yohanes Nugroho's WS-CON, Michael Petrie's English port, 
+the `wsconvert`project, Robert J. Sawyer's WordStar archive, and the WordStar 
+format documentation community. 
+
+My own test files are personal and are not distributed — this repo's tests use 
+synthetic fixtures and some public domain docs I retyped in WordStar 4 and 
+WordStar 7 in DOSBox-X, plus Robert J. Sawyer's public WS7 archive (opt-in, 
+`pytest -m sawyer`; see `tests/SAWYER-CORPUS.md`) you can run your own tests
+against that if you have a copy: download the archive, point
+`CTRLKD_SAWYER_ARCHIVE` at its top-level directory (the one holding
+`CONVERT.WS`, `INSET/`, `ARTICLES/`), and verify the path before arming —
+`tests/SAWYER-CORPUS.md` has a one-line smoke check. A `CTRLKD_PRIVATE_CORPUS`
+variable also exists, for my own private regression fixtures — it has no
+effect unless you're me.
+
+## Credits
+
+Written by Jon Michaels — whose 1987–1992 WordStar files, and the need to read
+them again, are the reason this exists — with Athena (Claude, Anthropic) as
+co-author.

ctrl_kd-4.5.1/src/ctrl_kd.egg-info/SOURCES.txt

@@ -0,0 +1,67 @@
+LICENSE
+README.md
+pyproject.toml
+src/ctrl_kd.egg-info/PKG-INFO
+src/ctrl_kd.egg-info/SOURCES.txt
+src/ctrl_kd.egg-info/dependency_links.txt
+src/ctrl_kd.egg-info/entry_points.txt
+src/ctrl_kd.egg-info/top_level.txt
+src/ctrlkd/__init__.py
+src/ctrlkd/afm.py
+src/ctrlkd/cli.py
+src/ctrlkd/convert.py
+src/ctrlkd/core.py
+src/ctrlkd/emit.py
+src/ctrlkd/fontmap.py
+src/ctrlkd/info.py
+src/ctrlkd/layout.py
+src/ctrlkd/pdf.py
+src/ctrlkd/pictures.py
+src/ctrlkd/pix.py
+src/ctrlkd/piximg.py
+src/ctrlkd/symbolmap.py
+src/ctrlkd/typestyles.py
+src/ctrlkd/writer.py
+src/ctrlkd/wschange.py
+src/ctrlkd/samples/LYING.WS
+src/ctrlkd/samples/OCAPTAIN.WS
+src/ctrlkd/samples/TWAINLET.WS
+src/ctrlkd/samples/WARPRAYR.WS
+tests/test_ctrlkd.py
+tests/test_endnote_leading_gap.py
+tests/test_fidelity_gate.py
+tests/test_flags_toc_inline.py
+tests/test_glyph_aspect.py
+tests/test_layout_marks.py
+tests/test_lj6dtp_bullet_glyph.py
+tests/test_lj6dtp_char_substitution.py
+tests/test_lj6dtp_colour_restore.py
+tests/test_lj6dtp_heading_face.py
+tests/test_lj6dtp_hp_patterns.py
+tests/test_lj6dtp_legend_line_spacing.py
+tests/test_lj6dtp_pcl_rectangles.py
+tests/test_lj6dtp_shading_table_rules.py
+tests/test_lj6dtp_table_rule_weight.py
+tests/test_load_plugins.py
+tests/test_modern_box_regions.py
+tests/test_modern_line_spacing.py
+tests/test_modern_lint.py
+tests/test_note_rulings_20260824.py
+tests/test_paper_verdicts.py
+tests/test_pcl_fidelity.py
+tests/test_pcl_tolerance.py
+tests/test_pictures.py
+tests/test_pix.py
+tests/test_polarity_gate.py
+tests/test_printed_fidelity.py
+tests/test_samples.py
+tests/test_sawyer_corpus.py
+tests/test_screenplay_detection.py
+tests/test_screenplay_pdf.py
+tests/test_screenplay_rendering.py
+tests/test_sentence_spacing_n9.py
+tests/test_style_leading.py
+tests/test_verse_quote_couplet.py
+tests/test_verse_spacing.py
+tests/test_writer.py
+tests/test_wschange.py

{ctrl_kd-4.0.1 → ctrl_kd-4.5.1}/src/ctrlkd/__init__.py

@@ -8,4 +8,4 @@ from .pdf import emit_pdf                        # registers the 'pdf' format
 from .convert import convert, select_notes, DEFAULT_NOTE_KINDS, ALL_NOTE_KINDS
 from .info import document_info
 
-__version__ = '4.0.1'
+__version__ = '4.5.1'