glitchlings 0.4.1__cp311-cp311-macosx_11_0_universal2.whl → 0.4.2__cp311-cp311-macosx_11_0_universal2.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=qAV0OXtnIGs4YnG_L9xUt9bhTcVhYKrDHfN6ZcBMMX4,1114
+glitchlings/__main__.py,sha256=f-P4jiVBd7ZpS6QxRpa_6SJgOG03UhZhcWasMDRWLs8,120
+glitchlings/_zoo_rust.cpython-311-darwin.so,sha256=WTXzOqP-45v51MizLNyiDaJwbeEnBLv88VZyeySMXB0,2488368
+glitchlings/compat.py,sha256=BdGFf4cKbbHbmLPirNT3U76AXhSn3vpZ59DfNdEQWPQ,6827
+glitchlings/config.py,sha256=TshOTvVlQOhokDTteTMTti-7S2qWnVUJR4LyBYDhQAQ,12638
+glitchlings/config.toml,sha256=MWwgbx1-KIRAY3JZmMrCVbZNxFjHgRJXbtNAVuUNcxY,108
+glitchlings/main.py,sha256=FIpDIqN42HCDCSpsU_JkSzyWC-ugszArwCLfmq_ZCYU,10090
+glitchlings/dlc/__init__.py,sha256=eTLEEWrVWPqniXHqee4W23H1rjElI1PQ_jcqWFe9D3g,141
+glitchlings/dlc/_shared.py,sha256=EFSnush3rjjaf4La5QfVaf_KEp0U_l_3-q4PKx0A6NQ,1972
+glitchlings/dlc/huggingface.py,sha256=9lW7TnTHA_bXyo4Is8pymZchrB9BIL1bMCP2p7LCMtg,2576
+glitchlings/dlc/prime.py,sha256=qGFI1d4BiOEIgQZ5v9QnlbYx4J4q-vNlh5tWZng11xs,8607
+glitchlings/lexicon/__init__.py,sha256=myW5MPFBvsurdisvolE6ECfUraO_mF8Dhyp_KhWxIGs,6244
+glitchlings/lexicon/_cache.py,sha256=KQBesSY-XkH2WwM7Xa_LAPbJEZgIARb2odgrZIHrme8,3948
+glitchlings/lexicon/graph.py,sha256=BbK1YfD9vgfQGDg-QTRegII10IDrervAsu6e20gTFPs,10057
+glitchlings/lexicon/metrics.py,sha256=VBFfFpxjiEwZtK-jS55H8xP7MTC_0OjY8lQ5zSQ9aTY,4572
+glitchlings/lexicon/vector.py,sha256=ILK727WItcHYIRqSVnaAAbGIlj9QTTqjbwHy43UXdb0,19671
+glitchlings/lexicon/wordnet.py,sha256=05ApyN9h0bSw0PQEfjZUeInmGWphxVIuGASc8Zoc5n0,6313
+glitchlings/lexicon/data/default_vector_cache.json,sha256=7obKHqmR3odbTfgJPWLSRFYFh4J_6uvv_CntCSe_EjI,725
+glitchlings/util/__init__.py,sha256=vc3EAY8ehRjbOiryFdaqvvljXcyNGtZSPiEp9ok1vVw,4674
+glitchlings/util/adapters.py,sha256=psxQFYSFmh1u7NuqtIrKwQP5FOhOrZoxZzc7X7DDi9U,693
+glitchlings/zoo/__init__.py,sha256=lu1wnD-lRDJy8uTJKVRwL4qL-nyb0Vyfz9GbiOletCI,5107
+glitchlings/zoo/_ocr_confusions.py,sha256=Ju2_avXiwsr1p8zWFUTOzMxJ8vT5PpYobuGIn4L_sqI,1204
+glitchlings/zoo/_rate.py,sha256=Vb1_5HAzrqr9eAh_zzngSV-d0zI264zcYspnT3VHPkE,504
+glitchlings/zoo/_sampling.py,sha256=KrWyUSsYXghlvktS5hQBO0bPqywEEyA49A2qDWInB7Q,1586
+glitchlings/zoo/_text_utils.py,sha256=fS5L_eq-foBbBdiv4ymI8-O0D0csc3yDekHpX8bqfV4,2754
+glitchlings/zoo/adjax.py,sha256=VJgUasyAk7K3E23B5PzoJ5HaqWtcPJG649TzQRAHraA,3528
+glitchlings/zoo/core.py,sha256=yuCgLXFWJtu2fLOJoCWLtHspbcTFRZhUKobv1AlqKqs,19385
+glitchlings/zoo/jargoyle.py,sha256=sUhCy_0sD0KOAHQKRmy9PTu9FwJitaSBDxdhuX9j7ME,11452
+glitchlings/zoo/mim1c.py,sha256=-fgodKWZq--Xw8L2t1EqNbsh48bwX5jZxmiXdoaQShI,3437
+glitchlings/zoo/ocr_confusions.tsv,sha256=KhtR7vJDTITpfTSGa-I7RHr6CK7LkGi2KjdhEWipI6o,183
+glitchlings/zoo/redactyl.py,sha256=6WgHIVumzRaDIyuLbewTJW5TXBs7s1CsKDPVXP4gkJc,5436
+glitchlings/zoo/reduple.py,sha256=GC1Sq4Ch7WOxL6gQZ9Ogs5EgXU2HkktLeMRVObBYFe4,4241
+glitchlings/zoo/rushmore.py,sha256=zxwiwcHHXHGLv8JLvKS4d0cduZ0qnwO9mcKOwXlMA1M,4305
+glitchlings/zoo/scannequin.py,sha256=JBpiSAnuSgCaEgPwCgSItiHms32wdLNXLPMotaBpYAs,4883
+glitchlings/zoo/typogre.py,sha256=7CHGfBkP4W2Bh8MCxtketA-3nlCb5QRCTUthRnXEhnk,6660
+glitchlings/zoo/zeedub.py,sha256=N4MBwWDRgcspLRlOCSAZ0hdwdnIj4h6uZLaJDFExj6Y,4823
+glitchlings-0.4.2.dist-info/licenses/LICENSE,sha256=YCvGip-LoaRyu6h0nPo71q6eHEkzUpsE11psDJOIRkw,11337
+glitchlings-0.4.2.dist-info/METADATA,sha256=1jm8iwNC4bhfp3nSc-O8POL_U0Fr6fw2RvvADpyxuqg,30721
+glitchlings-0.4.2.dist-info/WHEEL,sha256=Tgp8Vc-mmQm0KX-V22BSUoymoX1p0w13bZbX85y8hSs,114
+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=hEmQ1rl3G5uZBDbfJX_W4aIUNSsPAsy_Ai5DgQHasvk,813
-glitchlings/__main__.py,sha256=EOiBgay0x6B9VlSDzSQvMuoq6bHJdSvFSgcAVGGKkd4,121
-glitchlings/_zoo_rust.cpython-311-darwin.so,sha256=g3v99fyeGelWex500hqBOCSQ26suGLoU2wiq8yTnhGM,2488368
-glitchlings/config.py,sha256=hwkcMkhEvUzK8FECgG6kbf_4MpMQcopskiSgXzK5B3o,7785
-glitchlings/config.toml,sha256=MWwgbx1-KIRAY3JZmMrCVbZNxFjHgRJXbtNAVuUNcxY,108
-glitchlings/main.py,sha256=Rw9pCgNrGxwzC1rZbbng7cHUP9xlL0WWWTdjW95XiSM,10084
-glitchlings/dlc/__init__.py,sha256=eTLEEWrVWPqniXHqee4W23H1rjElI1PQ_jcqWFe9D3g,141
-glitchlings/dlc/huggingface.py,sha256=I1QWanWVxO02awgSpHDtgQEVF-9AQRLtsta2RCitWhE,2933
-glitchlings/dlc/prime.py,sha256=wpRMNtgka1vNlEzifeCjGMp1q_-QclZn3NxXczGnNpM,9278
-glitchlings/lexicon/__init__.py,sha256=e3MbtV3R_UOoZXsckR3gnThwgqCi4HXnfduaqxqYXvw,6229
-glitchlings/lexicon/_cache.py,sha256=KlcHKtOFH1yPxwhr8_HF_qgpALmUuHkGTzNfWnQ2Jb8,3955
-glitchlings/lexicon/graph.py,sha256=YYLrYnmSZ8uf8VvrNLuVF_nIVDH7OoR3RuxJ-9JMA2c,10041
-glitchlings/lexicon/metrics.py,sha256=W8TCemZaCjBOUSX8G7JdgQAbMykXXfRTfodkDSkc3aQ,4599
-glitchlings/lexicon/vector.py,sha256=oeZQwYxrK25REu4MhUUlMmaStW17Gx6RwrU1v6NooOg,19713
-glitchlings/lexicon/wordnet.py,sha256=Zv0YNHSM-DE2ucVZl_OOutTV1s0-i2xPOrfqYYdZKTU,6034
-glitchlings/lexicon/data/default_vector_cache.json,sha256=7obKHqmR3odbTfgJPWLSRFYFh4J_6uvv_CntCSe_EjI,725
-glitchlings/util/__init__.py,sha256=7KiZ0gKMjocfd34cajneZhTqYb7Hkwi_PpjltPqvkNI,4498
-glitchlings/zoo/__init__.py,sha256=eFYmaWeFDlSqfaiED51HWM-OqiTo_BOz0ASeyhOwOsw,4818
-glitchlings/zoo/_ocr_confusions.py,sha256=MkCbwk9T24SO2pD3JNPajYCfpMMlm2vQ5_sJty5GoXE,1218
-glitchlings/zoo/_rate.py,sha256=TMyfVFV7pLxSGVswPlOAtBvk25Bjtx5xXTtpb_utgik,527
-glitchlings/zoo/_sampling.py,sha256=VOSWDgYWXIiAuKxn2IckFJhpRgGotQP_KW28db8kTKI,1587
-glitchlings/zoo/_text_utils.py,sha256=nAfFT_VdXMXciCR7eQ5EAmym5wvzL6_Sdn9dvCx2s3Q,2758
-glitchlings/zoo/adjax.py,sha256=N3CzfM7m7mAYgFcQYLQkqK2VYLw_vFvEMBM2aNU--ZA,3530
-glitchlings/zoo/core.py,sha256=YymiEc66V4mW_4MbTST2038D7YdZVyRkiUZn886IV4I,17203
-glitchlings/zoo/jargoyle.py,sha256=6-DJxUFz2AjT-iQDFlK2ZG9pVwq2boDtslEzCNyI_04,11481
-glitchlings/zoo/mim1c.py,sha256=yAt1ngR3j2KXLbzc8LhrQlIWRO_KT5dFK1EE8QivMAQ,3429
-glitchlings/zoo/ocr_confusions.tsv,sha256=KhtR7vJDTITpfTSGa-I7RHr6CK7LkGi2KjdhEWipI6o,183
-glitchlings/zoo/redactyl.py,sha256=H4PwAMBCIsDw1KBOBiTR3VUbRZwynqakwwfx3wHjVp8,5457
-glitchlings/zoo/reduple.py,sha256=Q9NRCdvUgaHvvJu8A0n6zW9v_L3pdmNZbWqaJ7uycw4,4216
-glitchlings/zoo/rushmore.py,sha256=J1wd4IB7WOAR2TdntkxCMZWseWR0Yii8UQZ7ucfpWCc,4335
-glitchlings/zoo/scannequin.py,sha256=Ps8nxysKjkJV408zaL1kjVjy4jliATDBpYcNHLWbNFg,4859
-glitchlings/zoo/typogre.py,sha256=0fYaxOEiTnxiCqmsiSN1r_wl1vC1Ueaiks2e94kks70,6668
-glitchlings/zoo/zeedub.py,sha256=l51swlo556-TXhDk4nayHOm1XgHwWmfUKzQ01YMuCpE,4801
-glitchlings-0.4.1.dist-info/licenses/LICENSE,sha256=YCvGip-LoaRyu6h0nPo71q6eHEkzUpsE11psDJOIRkw,11337
-glitchlings-0.4.1.dist-info/METADATA,sha256=9HdqQt7PazdHMtPP5JpINljl3kvL8HOqTFE3Wwyrm2g,28260
-glitchlings-0.4.1.dist-info/WHEEL,sha256=Tgp8Vc-mmQm0KX-V22BSUoymoX1p0w13bZbX85y8hSs,114
-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,,