glitchlings 0.4.1__cp312-cp312-win_amd64.whl → 0.4.2__cp312-cp312-win_amd64.whl

glitchlings/zoo/typogre.py

@@ -4,9 +4,9 @@ import math
 import random
 from typing import Any, Optional
 
-from .core import Glitchling, AttackWave, AttackOrder
-from ._rate import resolve_rate
 from ..util import KEYNEIGHBORS
+from ._rate import resolve_rate
+from .core import AttackOrder, AttackWave, Glitchling
 
 try:
     from glitchlings._zoo_rust import fatfinger as _fatfinger_rust
@@ -64,9 +64,7 @@ def _python_eligible_idx(s: str, i: int) -> bool:
     return left_ok and right_ok
 
 
-def _python_draw_eligible_index(
-    rng: random.Random, s: str, max_tries: int = 16
-) -> Optional[int]:
+def _python_draw_eligible_index(rng: random.Random, s: str, max_tries: int = 16) -> Optional[int]:
     n = len(s)
     if n == 0:
         return None
@@ -151,7 +149,6 @@ def fatfinger(
     max_change_rate: float | None = None,
 ) -> str:
     """Introduce character-level "fat finger" edits with a Rust fast path."""
-
     effective_rate = resolve_rate(
         rate=rate,
         legacy_value=max_change_rate,
@@ -230,4 +227,3 @@ typogre = Typogre()
 
 
 __all__ = ["Typogre", "typogre"]
-

glitchlings/zoo/zeedub.py

@@ -3,9 +3,10 @@ from __future__ import annotations
 import math
 import random
 from collections.abc import Sequence
+from typing import Any
 
-from .core import Glitchling, AttackWave, AttackOrder
 from ._rate import resolve_rate
+from .core import AttackOrder, AttackWave, Glitchling
 
 try:
     from glitchlings._zoo_rust import inject_zero_widths as _inject_zero_widths_rust
@@ -77,7 +78,6 @@ def insert_zero_widths(
     characters: Sequence[str] | None = None,
 ) -> str:
     """Inject zero-width characters between non-space character pairs."""
-
     effective_rate = resolve_rate(
         rate=rate,
         legacy_value=None,

{glitchlings-0.4.1.dist-info → glitchlings-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glitchlings
-Version: 0.4.1
+Version: 0.4.2
 Summary: Monsters for your language games.
 Author: osoleve
 License:                                  Apache License
@@ -239,6 +239,16 @@ Provides-Extra: dev
 Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: hypothesis>=6.140.0; extra == "dev"
 Requires-Dist: numpy<=2.0,>=1.24; extra == "dev"
+Requires-Dist: mkdocs>=1.6.0; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "dev"
+Requires-Dist: mkdocs-material>=9.5.0; extra == "dev"
+Requires-Dist: mkdocstrings-python>=1.10.0; extra == "dev"
+Requires-Dist: interrogate>=1.5.0; extra == "dev"
+Requires-Dist: black>=24.4.0; extra == "dev"
+Requires-Dist: isort>=5.13.0; extra == "dev"
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: pre-commit>=3.8.0; extra == "dev"
 Dynamic: license-file
 
 #
@@ -338,10 +348,66 @@ They're horrible little gremlins, but they're not _unreasonable_.
 
 Keyboard warriors can challenge them directly via the `glitchlings` command:
 
+<!-- BEGIN: CLI_USAGE -->
 ```bash
 # Discover which glitchlings are currently on the loose.
 glitchlings --list
+```
+
+```text
+   Typogre — scope: Character, order: early
+     Mim1c — scope: Character, order: last
+  Jargoyle — scope: Word, order: normal
+     Adjax — scope: Word, order: normal
+   Reduple — scope: Word, order: normal
+  Rushmore — scope: Word, order: normal
+  Redactyl — scope: Word, order: normal
+Scannequin — scope: Character, order: late
+    Zeedub — scope: Character, order: last
+```
+
+```bash
+# Review the full CLI contract.
+glitchlings --help
+```
 
+```text
+usage: glitchlings [-h] [-g SPEC] [-s SEED] [-f FILE] [--sample] [--diff]
+                   [--list] [-c CONFIG]
+                   [text]
+
+Summon glitchlings to corrupt text. Provide input text as an argument, via
+--file, or pipe it on stdin.
+
+positional arguments:
+  text                  Text to corrupt. If omitted, stdin is used or --sample
+                        provides fallback text.
+
+options:
+  -h, --help            show this help message and exit
+  -g SPEC, --glitchling SPEC
+                        Glitchling to apply, optionally with parameters like
+                        Typogre(rate=0.05). Repeat for multiples; defaults to
+                        all built-ins.
+  -s SEED, --seed SEED  Seed controlling deterministic corruption order
+                        (default: 151).
+  -f FILE, --file FILE  Read input text from a file instead of the command
+                        line argument.
+  --sample              Use the included SAMPLE_TEXT when no other input is
+                        provided.
+  --diff                Show a unified diff between the original and corrupted
+                        text.
+  --list                List available glitchlings and exit.
+  -c CONFIG, --config CONFIG
+                        Load glitchlings from a YAML configuration file.
+```
+<!-- END: CLI_USAGE -->
+
+Run `python docs/build_cli_reference.py` whenever you tweak the CLI so the README stays in sync with the actual output. The script executes the commands above and replaces the block between the markers automatically.
+
+Prefer inline tweaks? You can still configure glitchlings directly in the shell:
+
+```bash
 # Run Typogre against the contents of a file and inspect the diff.
 glitchlings -g typogre --file documents/report.txt --diff
 
@@ -355,8 +421,6 @@ echo "Beware LLM-written flavor-text" | glitchlings -g mim1c
 glitchlings --config experiments/chaos.yaml "Let slips the glitchlings of war"
 ```
 
-Use `--help` for a complete breakdown of available options, including support for parameterised glitchlings via `-g "Name(arg=value, ...)"` to mirror the Python API.
-
 Attack configurations live in plain YAML files so you can version-control experiments without touching code:
 
 ```yaml

glitchlings-0.4.2.dist-info/RECORD

@@ -0,0 +1,42 @@
+glitchlings/__init__.py,sha256=PggQt66bImHyWBggz5CTTFvB19P7iOCMjp2uncvcgXA,1177
+glitchlings/__main__.py,sha256=nB7btO_T4wBFOcyawfWpjEindVrUfTqqV5hdeeS1HT8,128
+glitchlings/_zoo_rust.cp312-win_amd64.pyd,sha256=_J4R5tA4q8CesIZ-K-3OJybUoy-NM_-kmHyo5-GE9vU,2103808
+glitchlings/compat.py,sha256=qba3_W4W5edy9_hoPkekBRNhYy34eG2yCdyWaNrbxeg,7042
+glitchlings/config.py,sha256=USnSw5-HO0ghsuwbmEvimZ4acU2EeNChB6RPlBFj4hc,13013
+glitchlings/config.toml,sha256=EOEqKUwPygOv7MuEuExil5ZQfwKV1H2hU-Z5aBKQ440,111
+glitchlings/main.py,sha256=JDgfHPDhRvZVb7bYQAFGHTRxH8yGNlgStlBqv-y5Thk,10444
+glitchlings/dlc/__init__.py,sha256=IHD-GGhVFb7SVzErvf2YCJkOR4wGo0nFHXkn_daMvS8,146
+glitchlings/dlc/_shared.py,sha256=i66HyJJiHpR0mug7zmfmxB17Vs3CSqBTsk5CuVaLDk0,2040
+glitchlings/dlc/huggingface.py,sha256=Ym8dTArb-43AnCyukOO1m66iAbs8al9YkIWB3rGdhTk,2657
+glitchlings/dlc/prime.py,sha256=KY3so8WOwksbsKhZXfWorsZSYvIdPiUtc8e9apHabkM,8861
+glitchlings/lexicon/__init__.py,sha256=N1G-0xL-dkjRECEhLE1j7BrpBW6evqtjmcG5kiAczTM,6442
+glitchlings/lexicon/_cache.py,sha256=cQCO-dizyClUz8FU8xyaeaJDBxqwrDo6v3YyJ-MQfp0,4052
+glitchlings/lexicon/graph.py,sha256=00HQEbjNVXuBkgCyQy-ru6BB9GHDKiSJXv1TIillXRw,10339
+glitchlings/lexicon/metrics.py,sha256=TZAafSKgHpUS4h6vCuhTKGsvu_fru9kMqsXqLID6BTM,4734
+glitchlings/lexicon/vector.py,sha256=6QDQB2LAjRu1dZwlGYhkkdHyGv9UO79jUbf6KEtjvac,20243
+glitchlings/lexicon/wordnet.py,sha256=YoEOMSIPrkrIORR3wMnPftKJLYh5PBQ7PTNrzZGchxg,6504
+glitchlings/lexicon/data/default_vector_cache.json,sha256=fLT-v1sgF0lv88aPwOP23br9azrjeAkJ1ft6OgPlMeM,741
+glitchlings/util/__init__.py,sha256=Q5lkncOaM6f2eJK3HAtZyxpCjGnekCpwPloqasS3JDo,4869
+glitchlings/util/adapters.py,sha256=mFhPlE8JaFuO_C-3_aqhgwkqa6isV8Y2ifqVh3Iv9JM,720
+glitchlings/zoo/__init__.py,sha256=EljxDKxbl6E4hTuC7Ul98dsp-FvJ2nXQTvD5LoWToWc,5271
+glitchlings/zoo/_ocr_confusions.py,sha256=pPlvJOoan3ouwwGt8hATcO-9luIrGJl0vwUqssUMXD8,1236
+glitchlings/zoo/_rate.py,sha256=o7B9_EfadjshSGLH0B5BHgj1J0OJWVCSXkEE8hljmxc,522
+glitchlings/zoo/_sampling.py,sha256=AAPLObjqKrmX882TX8hdvPHReBOcv0Z4pUuW6AxuGgU,1640
+glitchlings/zoo/_text_utils.py,sha256=LqCa33E-Qxbk6N5AVfxEmAz6C2u7_mCF0xPT9-404A8,2854
+glitchlings/zoo/adjax.py,sha256=Rx8PxK9MBecaSXHJv7rXzWL2uP1QTdNuO2XohPZ61uo,3657
+glitchlings/zoo/core.py,sha256=OE3zZYtyqlQoJkycxl5ZOG52Rxqi05Hd4rr2CAGUhrw,19929
+glitchlings/zoo/jargoyle.py,sha256=fnSXlHlOlVFNKUP44V1TyXFmDYAt1dm1tV2dGL8hCFU,11773
+glitchlings/zoo/mim1c.py,sha256=GqUMErVAVcqMAZjx4hhJ0Af25CxA0Aorv3U_fTqLZek,3546
+glitchlings/zoo/ocr_confusions.tsv,sha256=S-IJEYCIXYKT1Uu7Id8Lnvg5pw528yNigTtWUdnMv9k,213
+glitchlings/zoo/redactyl.py,sha256=0xGFuygN-vCsNplm3UddzFf2pWqvl7RShUFyXNdSzJ4,5627
+glitchlings/zoo/reduple.py,sha256=lpKNqpSk-gzLKryxvobuikTpG3uOXZqPntyxmeeuPhg,4390
+glitchlings/zoo/rushmore.py,sha256=_jU78_q_iJAWffjfq24WwQ2teyQ4brKOFoOU4IZnM7k,4459
+glitchlings/zoo/scannequin.py,sha256=INTZlzskkXPy8zz6O19DBAbyRLQxvFK0AYhwjLfY7Ec,5055
+glitchlings/zoo/typogre.py,sha256=zXvZX8V_0yDmEaLheWKBRa9vCEnSc9TiekYUqZITx0w,6889
+glitchlings/zoo/zeedub.py,sha256=0k7IuTWXbMt5B-1IOwzGk29EvHZNkxyEQUlZloIcrOc,5006
+glitchlings-0.4.2.dist-info/licenses/LICENSE,sha256=EFEP1evBfHaxsMTBjxm0sZVRp2wct8QLvHE1saII5FI,11538
+glitchlings-0.4.2.dist-info/METADATA,sha256=9h2Wc3BbR0pm6d-_AfOcMvTJFL06cVuQFw43d2BVYns,31312
+glitchlings-0.4.2.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
+glitchlings-0.4.2.dist-info/entry_points.txt,sha256=kGOwuAsjFDLtztLisaXtOouq9wFVMOJg5FzaAkg-Hto,54
+glitchlings-0.4.2.dist-info/top_level.txt,sha256=VHFNBrLjtDwPCYXbGKi6o17Eueedi81eNbR3hBOoST0,12
+glitchlings-0.4.2.dist-info/RECORD,,

glitchlings-0.4.1.dist-info/RECORD

@@ -1,39 +0,0 @@
-glitchlings/__init__.py,sha256=onTBFM_ih4O1E1ntZaNaFxiMcD5NtCGc4TaX276sgNk,867
-glitchlings/__main__.py,sha256=pqNe1C9hMf8pap4oh6x6yo2h4Nsa2RFSaMWHfGtNXj0,130
-glitchlings/_zoo_rust.cp312-win_amd64.pyd,sha256=EMWrDQpRnkzHPhEiK2X7H1qcMPnNN_eIAx_SbAsKlas,2103808
-glitchlings/config.py,sha256=P6qMJdHrvZYAIUj7NXxrpEKcv6lDy8Eo4toWu3ctsHs,8043
-glitchlings/config.toml,sha256=EOEqKUwPygOv7MuEuExil5ZQfwKV1H2hU-Z5aBKQ440,111
-glitchlings/main.py,sha256=sKdUk4trBS-yNbEAOwdTXldg87TSPwnSAr_inecj4bE,10442
-glitchlings/dlc/__init__.py,sha256=IHD-GGhVFb7SVzErvf2YCJkOR4wGo0nFHXkn_daMvS8,146
-glitchlings/dlc/huggingface.py,sha256=PIesnDIEvyJxj1IuLw2P9nVPTr4Nv81XM7w2axfyhkA,3029
-glitchlings/dlc/prime.py,sha256=b5CE1qDl5MxZjTudlKrqMsmSGxXNKZ16krqPyrr2nK8,9569
-glitchlings/lexicon/__init__.py,sha256=WTX3vZhbhjd-WsRs63RT9Lw6KSfPW7SfzP2R3L_MFx0,6438
-glitchlings/lexicon/_cache.py,sha256=3hiGngtRlMfqKK4vIOnvjxb0tvCfF5u7DZP3wbn2Zlc,4066
-glitchlings/lexicon/graph.py,sha256=-AEh3eybkuUbVYg4GtOSvZhSqvik2QYY49A-lcNSi1I,10331
-glitchlings/lexicon/metrics.py,sha256=zwd3vm9-pUQbSywORXgHyHCfAjIJs8S5rPNQ70UYgUo,4768
-glitchlings/lexicon/vector.py,sha256=rEAKk8o8l8DfiV_-9D-9asLKg1dYc9MzHA5_oRmNIVM,20304
-glitchlings/lexicon/wordnet.py,sha256=EeZ1bZx9y-snjEsgItpJTysR1pDNpyO8CxcUztjloj4,6226
-glitchlings/lexicon/data/default_vector_cache.json,sha256=fLT-v1sgF0lv88aPwOP23br9azrjeAkJ1ft6OgPlMeM,741
-glitchlings/util/__init__.py,sha256=GoyQuHTfGRkHzuZwJji6QWSiGd_LHa9QiyjjEpBFW7E,4679
-glitchlings/zoo/__init__.py,sha256=AQu2Z0ECuzQDXwM_DbGaNzkcjLu8WptJS17sh6WTyyA,4975
-glitchlings/zoo/_ocr_confusions.py,sha256=W59Aa5MBDwRF65f8GV-6XwGAmlR5Uk7pa5qvHvhIYdY,1252
-glitchlings/zoo/_rate.py,sha256=EYUWXYyR2IK0zYBWyBOlnUjDxU32JE9mZTZeodVx5CA,548
-glitchlings/zoo/_sampling.py,sha256=UK-XmEERjtY7nLaWDp81yktuZ_K80Un-9tvj4MjsHcg,1642
-glitchlings/zoo/_text_utils.py,sha256=YxV069L8c0YSn5iCp72Dv8XCdfhbcFeBrbMoBeKIDns,2862
-glitchlings/zoo/adjax.py,sha256=G2diAEsQ8T4mjFCcTeiGzLF0261n7LjLyW5HyVCy3R4,3661
-glitchlings/zoo/core.py,sha256=zptaRvSL4wFdiUkmy_x4tD4CUD0la_egDQVMZ1n3xj0,17708
-glitchlings/zoo/jargoyle.py,sha256=yRSVRKHdnaUfZMDJ6miBhRQpPHfYK9iD2DCYMp-7Dec,11807
-glitchlings/zoo/mim1c.py,sha256=3ddNOzWgLABuEOh5T98Xk439ejx-YHGI7ErXET03Crc,3537
-glitchlings/zoo/ocr_confusions.tsv,sha256=S-IJEYCIXYKT1Uu7Id8Lnvg5pw528yNigTtWUdnMv9k,213
-glitchlings/zoo/redactyl.py,sha256=P2YYo1V_u62WIj8zqgDpbzDsreGx2I77BJ0RkdCKhXU,5651
-glitchlings/zoo/reduple.py,sha256=w90xQWQKwkY3tItk8S20emDQy4FLDbee9rrPyh_ffpg,4363
-glitchlings/zoo/rushmore.py,sha256=amAk44TIQBN4rU1c-W1g7I6WForGJMGxNb8uaa8Zfaw,4495
-glitchlings/zoo/scannequin.py,sha256=TJyNYTTIB7rxZH3XKIETy0YVf4EjsMgGWYmYaxH9jxU,5030
-glitchlings/zoo/typogre.py,sha256=j7LuAyYLrP6LjmCm8Jwi_wPxhTAP_TmWbt5pQrOvFZk,6901
-glitchlings/zoo/zeedub.py,sha256=J8F1XZeCMQVVtzWwNiFhOeogjBt1BsOtqrnDjlwUcl8,4984
-glitchlings-0.4.1.dist-info/licenses/LICENSE,sha256=EFEP1evBfHaxsMTBjxm0sZVRp2wct8QLvHE1saII5FI,11538
-glitchlings-0.4.1.dist-info/METADATA,sha256=5cwuNjNuQCoGUBsM_xipGSoDmC1DBb8AJGhrAeRFnDI,28787
-glitchlings-0.4.1.dist-info/WHEEL,sha256=8UP9x9puWI0P1V_d7K2oMTBqfeLNm21CTzZ_Ptr0NXU,101
-glitchlings-0.4.1.dist-info/entry_points.txt,sha256=kGOwuAsjFDLtztLisaXtOouq9wFVMOJg5FzaAkg-Hto,54
-glitchlings-0.4.1.dist-info/top_level.txt,sha256=VHFNBrLjtDwPCYXbGKi6o17Eueedi81eNbR3hBOoST0,12
-glitchlings-0.4.1.dist-info/RECORD,,