glitchlings 0.1.0__tar.gz → 0.1.1__tar.gz

{glitchlings-0.1.0 → glitchlings-0.1.1}/.gitignore

@@ -10,3 +10,5 @@ wheels/
 .venv
 .python-version
 uv.lock
+
+RELEASE.md

glitchlings-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 osoleve
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

glitchlings-0.1.1/PKG-INFO

@@ -0,0 +1,429 @@
+Metadata-Version: 2.4
+Name: glitchlings
+Version: 0.1.1
+Summary: Monsters for your language games.
+Project-URL: Homepage, https://github.com/osoleve/glitchlings
+Project-URL: Repository, https://github.com/osoleve/glitchlings.git
+Project-URL: Issues, https://github.com/osoleve/glitchlings/issues
+Project-URL: Changelog, https://github.com/osoleve/glitchlings/releases
+Author: osoleve
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2025 osoleve
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: adversarial,data,evaluation,glitch,nlp,text
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Requires-Dist: confusable-homoglyphs>=3.3.1
+Requires-Dist: datasets>=4.0.0
+Requires-Dist: jellyfish>=1.2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Provides-Extra: jargoyle
+Requires-Dist: nltk>=3.9.1; extra == 'jargoyle'
+Provides-Extra: prime
+Requires-Dist: verifiers>=0.1.3.post0; extra == 'prime'
+Description-Content-Type: text/markdown
+
+#
+
+```plaintext
+     .─') _                                       .─') _                  
+    (  OO) )                                     ( OO ) )            
+  ░██████  ░██ ░██   ░██               ░██       ░██ ░██                                 
+ ░██   ░██ ░██       ░██               ░██       ░██                                     
+░██        ░██ ░██░████████  ░███████ ░████████  ░██ ░██░████████   ░████████ ░███████  
+░██  █████ ░██ ░██   ░██    ░██('─.░██ ░██    ░██ ░██ ░██░██    ░██ ░██.─')░██ ░██        
+░██     ██ ░██ ░██   ░██    ░██( OO ) ╱░██    ░██ ░██ ░██░██    ░██ ░██(OO)░██ ░███████  
+  ░██  ░███ ░██ ░██   ░██   ░██    ░██ ░██    ░██ ░██ ░██░██    ░██ ░██  o░███      ░██ 
+  ░█████░█ ░██ ░██   ░████   ░███████  ░██    ░██ ░██ ░██░██    ░██  ░█████░██ ░███████  
+                                                                    ░██            
+                                                                ░███████             
+
+                        Every language game breeds monsters.
+```
+
+`Glitchlings` are **utilities for corrupting the text inputs to your language models in deterministic, _linguistically principled_** ways.  
+Each embodies a different way that documents can be compromised in the wild.
+
+If reinforcement learning environments are games, then `Glitchling`s are enemies to breathe new life into old challenges.
+
+They do this by breaking surface patterns in the input while keeping the target output intact.
+
+Some `Glitchling`s are petty nuisances. Some `Glitchling`s are eldritch horrors.  
+Together, they create truly nightmarish scenarios for your language models.
+
+After all, what good is general intelligence if it can't handle a little chaos?
+
+-_The Curator_
+
+## Quickstart
+
+```python
+pip install -U glitchlings
+```
+
+```python
+from glitchlings import summon, SAMPLE_TEXT
+
+gaggle = summon(["reduple", "mim1c", "typogre", "rushmore"])
+gaggle(SAMPLE_TEXT)
+```
+
+> Onҽ m‎ھ‎rning, wһen Gregor Samƽa woke from trouble𝐝 𝑑reams, he found himself transformed in his bed into a horrible vermin‎٠‎ He l   lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightlh domed and divided by arches ino stiff sections. The bedding was adly able to cover it and and seemed ready to slide off any  moment. His many legxs, pitifully thin compared with the size of the the rest of him, waved about helplessly ashe looked looked.
+
+## Motivation
+
+If your model performs well on a particular task, but not when `Glitchling`s are present, it's a sign that it hasn't actually generalized to the problem.
+
+Conversely, training a model to perform well in the presence of the types of perturbations introduced by `Glitchling`s should help it generalize better.
+
+## Your First Battle
+
+Summon your chosen `Glitchling` (_or a few, if ya nasty_) and call it on your text or slot it into `Dataset.map(...)`, supplying a seed if desired.  
+Some `Glitchling`s may have additional keyword arguments but they will always be optional with what I decide are "reasonable defaults".  
+Seed defaults to 151, obviously.
+
+Calling a `Glitchling` on a `str` transparently calls `.corrupt(str, ...) -> str`.  
+This means that as long as your glitchlings get along logically, they play nicely with one another.
+
+When summoned as a `Gaggle`, the `Glitchling`s will automatically order themselves into attack waves, based on the scope of the change they make:
+
+1. Document
+2. Paragraph
+3. Sentence
+4. Word
+5. Character
+
+They're horrible little gremlins, but they're not _unreasonable_.
+
+## Starter 'lings
+
+For maintainability reasons, all `Glitchling` have consented to be given nicknames once they're in your care. See the [Monster Manual](MONSTER_MANUAL.md) for a complete bestiary.
+
+### Typogre
+
+_What a nice word, would be a shame if something happened to it._
+
+> _**Fatfinger.**_ Typogre introduces character-level errors (duplicating, dropping, adding, or swapping) based on the layout of a (currently QWERTY) keyboard.
+>
+> Args
+>
+> - `max_change_rate (float)`: The maximum number of edits to make as a percentage of the length (default: 0.02, 2%).
+> - `preserve_first_last (bool)`: Avoid editing the first and last character of a word (default: False).
+> - `keyboard (str)`: Keyboard layout key-neighbor map to use (default: "CURATOR_QWERTY").
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Mim1c
+
+_Wait, was that...?_
+
+> _**Confusion.**_ Mim1c replaces non-space characters with Unicode Confusables, characters that are distinct but would not usually confuse a human reader.
+>
+> Args
+>
+> - `replacement_rate (float)`: The maximum proportion of characters to replace (default: 0.02, 2%).
+> - `classes (list[str] | "all")`: Restrict replacements to these Unicode script classes (default: ["LATIN", "GREEK", "CYRILLIC"]).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Scannequin
+
+_How can a computer need reading glasses?_
+
+> _**OCR Artifacts.**_ Scannequin mimics optical character recognition errors by swapping visually similar character sequences (like rn↔m, cl↔d, O↔0, l/I/1).
+>
+> Args
+>
+> - `error_rate (float)`: The maximum proportion of eligible confusion spans to replace (default: 0.02, 2%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Jargoyle
+
+_Uh oh. The worst person you know just bought a thesaurus._
+
+> _**Sesquipedalianism.**_ Jargoyle, the insufferable `Glitchling`, replaces nouns with synonyms at random, without regard for connotational or denotational differences.
+>
+> Args
+>
+> - `replacement_rate (float)`: The maximum proportion of words to replace (default: 0.1, 10%).
+> - `part_of_speech`: The WordNet part of speech to target (default: nouns). Accepts `wn.NOUN`, `wn.VERB`, `wn.ADJ`, or `wn.ADV`.
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Reduple
+
+_Did you say that or did I?_
+
+> _**Broken Record.**_ Reduple stutters through text by randomly reduplicating words. Like a nervous speaker, it creates natural repetitions that test a model's ability to handle redundancy without losing the thread.
+>
+> Args
+>
+> - `reduplication_rate (float)`: The maximum proportion of words to reduplicate (default: 0.05, 5%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Rushmore
+
+_I accidentally an entire word._
+
+> _**Hasty Omission.**_ The evil (?) twin of `reduple`, Rushmore moves with such frantic speed that it causes words to simply vanish from existence as it passes.
+>
+> Args
+>
+> - `max_deletion_rate (float)`: The maximum proportion of words to delete (default: 0.01, 1%).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+### Redactyl
+
+_Oops, that was my black highlighter._
+
+> _**FOIA Reply.**_ Redactyl obscures random words in your document like an NSA analyst with a bad sense of humor.
+>
+> ### Args
+>
+> - `replacement_char (str)`: The character to use for redaction (default: █).
+> - `redaction_rate (float)`: The maximum proportion of words to redact (default: 0.05, 5%).
+> - `merge_adjacent (bool)`: Whether to redact the space between adjacent redacted words (default: False).
+> - `seed (int)`: The random seed for reproducibility (default: 151).
+
+## Field Report: Uncontained Specimens
+
+### _Containment procedures pending_
+
+- `ekkokin` substitutes words with homophones (phonetic equivalents).
+- `nylingual` backtranslates portions of text.
+- `glothopper` introduces code-switching effects, blending languages or dialects.
+- `palimpsest` rewrites, but leaves accidental traces of the past.
+- `vesuvius` is an apocryphal `Glitchling` with ties to _[Nosy, aren't we? -The Curator]_
+
+## Apocrypha
+
+Cave paintings and oral tradition contain many depictions of strange, otherworldly `Glitchling`s.  
+These _Apocryphal `Glitchling`_ are said to possess unique abilities or behaviors.  
+If you encounter one of these elusive beings, please document your findings and share them with _The Curator_.
+
+### Reproducible Corruption
+
+Every `Glitchling` owns its own independent `random.Random` instance. That means:
+
+- No `random.seed(...)` calls touch Python's global RNG.
+- Supplying a `seed` when you construct a `Glitchling` (or when you `summon(...)`) makes its behavior reproducible.
+- Re-running a `Gaggle` with the same master seed and the same input text (_and same external data!_) yields identical corruption output.
+- Corruption functions are written to accept an `rng` parameter internally so that all randomness is centralized and testable.
+
+#### Caveats
+
+- If you mutate a glitchling's parameters after you've used it (e.g. `typogre.set_param(...)`) the outputs may not be the same as before the change. So don't do that.
+
+#### At Wits' End?
+
+If you're trying to add a new glitchling and can't seem to make it deterministic, here are some places to look for determinism-breaking code:
+
+1. Search for any direct calls to `random.choice`, `random.shuffle`, or `set(...)` ordering without going through the provided `rng`.
+2. Ensure you sort collections before shuffling or sampling.
+3. Make sure indices are chosen from a stable reference (e.g., original text) when applying length‑changing edits.
+4. Make sure there are enough sort keys to maintain stability.

{glitchlings-0.1.0 → glitchlings-0.1.1}/README.md

@@ -3,15 +3,15 @@
 ```plaintext
      .─') _                                       .─') _                  
     (  OO) )                                     ( OO ) )            
-  ░██████  ░██ ░██   ░██               ░██        ░██ ░██                                 
- ░██   ░██ ░██       ░██               ░██        ░██                                     
+  ░██████  ░██ ░██   ░██               ░██       ░██ ░██                                 
+ ░██   ░██ ░██       ░██               ░██       ░██                                     
 ░██        ░██ ░██░████████  ░███████ ░████████  ░██ ░██░████████   ░████████ ░███████  
 ░██  █████ ░██ ░██   ░██    ░██('─.░██ ░██    ░██ ░██ ░██░██    ░██ ░██.─')░██ ░██        
 ░██     ██ ░██ ░██   ░██    ░██( OO ) ╱░██    ░██ ░██ ░██░██    ░██ ░██(OO)░██ ░███████  
   ░██  ░███ ░██ ░██   ░██   ░██    ░██ ░██    ░██ ░██ ░██░██    ░██ ░██  o░███      ░██ 
   ░█████░█ ░██ ░██   ░████   ░███████  ░██    ░██ ░██ ░██░██    ░██  ░█████░██ ░███████  
-                                                                           ░██            
-                                                                     ░███████             
+                                                                    ░██            
+                                                                ░███████             
 
                         Every language game breeds monsters.
 ```
@@ -32,6 +32,10 @@ After all, what good is general intelligence if it can't handle a little chaos?
 
 ## Quickstart
 
+```python
+pip install -U glitchlings
+```
+
 ```python
 from glitchlings import summon, SAMPLE_TEXT
 

{glitchlings-0.1.0 → glitchlings-0.1.1}/pyproject.toml

@@ -1,24 +1,26 @@
 [project]
 name = "glitchlings"
-version = "0.1.0"
+version = "0.1.1"
 description = "Monsters for your language games."
 readme = "README.md"
 requires-python = ">=3.12"
+
 dependencies = [
     "confusable-homoglyphs>=3.3.1",
     "datasets>=4.0.0",
     "jellyfish>=1.2.0",
-    "nltk>=3.9.1",
 ]
 
 authors = [
     { name = "osoleve" }
 ]
+
 keywords = ["nlp", "text", "adversarial", "data", "evaluation", "glitch"]
+
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
+    "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
@@ -40,6 +42,9 @@ Changelog = "https://github.com/osoleve/glitchlings/releases"
 glitchlings = "glitchlings.main:main"
 
 [project.optional-dependencies]
+jargoyle = [
+    "nltk>=3.9.1",
+]
 prime = [
     "verifiers>=0.1.3.post0",
 ]

{glitchlings-0.1.0 → glitchlings-0.1.1}/zoo/reduple.py

@@ -36,15 +36,15 @@ def reduplicate_words(
             continue
 
         # Only consider actual words for reduplication
-    if rng.random() < reduplication_rate:
-        # Check if word has trailing punctuation
-        match = re.match(r"^(\W*)(.*?)(\W*)$", word)
-        if match:
-            prefix, core, suffix = match.groups()
-            # Reduplicate with a space: "word" -> "word word"
-            tokens[i] = f"{prefix}{core} {core}{suffix}"
-        else:
-            tokens[i] = f"{word} {word}"
+        if rng.random() < reduplication_rate:
+            # Check if word has trailing punctuation
+            match = re.match(r"^(\W*)(.*?)(\W*)$", word)
+            if match:
+                prefix, core, suffix = match.groups()
+                # Reduplicate with a space: "word" -> "word word"
+                tokens[i] = f"{prefix}{core} {core}{suffix}"
+            else:
+                tokens[i] = f"{word} {word}"
 
     return "".join(tokens)
 

{glitchlings-0.1.0 → glitchlings-0.1.1}/zoo/rushmore.py

@@ -34,14 +34,14 @@ def delete_random_words(
             continue
 
         # Only consider actual words for deletion
-    if rng.random() < max_deletion_rate:
-        # Check if word has trailing punctuation
-        match = re.match(r"^(\W*)(.*?)(\W*)$", word)
-        if match:
-            prefix, _, suffix = match.groups()
-            tokens[i] = f"{prefix.strip()}{suffix.strip()}"
-        else:
-            tokens[i] = ""
+        if rng.random() < max_deletion_rate:
+            # Check if word has trailing punctuation
+            match = re.match(r"^(\W*)(.*?)(\W*)$", word)
+            if match:
+                prefix, _, suffix = match.groups()
+                tokens[i] = f"{prefix.strip()}{suffix.strip()}"
+            else:
+                tokens[i] = ""
 
     text = "".join(tokens)
     text = re.sub(r"\s+([.,;:])", r"\1", text)

glitchlings-0.1.0/.github/workflows/testpypi.yml

@@ -1,38 +0,0 @@
-name: Publish to TestPyPI
-
-on:
-  push:
-    branches: [ trunk ]
-
-jobs:
-  build-and-publish-testpypi:
-    if: ${{ secrets.TEST_PYPI_API_TOKEN != '' }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install build tools
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install build twine
-
-      - name: Build sdist and wheel
-        run: |
-          python -m build
-        working-directory: glitchlings
-
-      - name: Upload to TestPyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: glitchlings/dist
-          repository-url: https://test.pypi.org/legacy/
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

glitchlings-0.1.0/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 osoleve
-
-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.

glitchlings-0.1.0/PKG-INFO

@@ -1,244 +0,0 @@
-Metadata-Version: 2.4
-Name: glitchlings
-Version: 0.1.0
-Summary: Monsters for your language games.
-Project-URL: Homepage, https://github.com/osoleve/glitchlings
-Project-URL: Repository, https://github.com/osoleve/glitchlings.git
-Project-URL: Issues, https://github.com/osoleve/glitchlings/issues
-Project-URL: Changelog, https://github.com/osoleve/glitchlings/releases
-Author: osoleve
-License: MIT License
-        
-        Copyright (c) 2025 osoleve
-        
-        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.
-License-File: LICENSE
-Keywords: adversarial,data,evaluation,glitch,nlp,text
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Topic :: Software Development :: Testing
-Requires-Python: >=3.12
-Requires-Dist: confusable-homoglyphs>=3.3.1
-Requires-Dist: datasets>=4.0.0
-Requires-Dist: jellyfish>=1.2.0
-Requires-Dist: nltk>=3.9.1
-Provides-Extra: dev
-Requires-Dist: pytest>=8.0.0; extra == 'dev'
-Provides-Extra: prime
-Requires-Dist: verifiers>=0.1.3.post0; extra == 'prime'
-Description-Content-Type: text/markdown
-
-#
-
-```plaintext
-     .─') _                                       .─') _                  
-    (  OO) )                                     ( OO ) )            
-  ░██████  ░██ ░██   ░██               ░██        ░██ ░██                                 
- ░██   ░██ ░██       ░██               ░██        ░██                                     
-░██        ░██ ░██░████████  ░███████ ░████████  ░██ ░██░████████   ░████████ ░███████  
-░██  █████ ░██ ░██   ░██    ░██('─.░██ ░██    ░██ ░██ ░██░██    ░██ ░██.─')░██ ░██        
-░██     ██ ░██ ░██   ░██    ░██( OO ) ╱░██    ░██ ░██ ░██░██    ░██ ░██(OO)░██ ░███████  
-  ░██  ░███ ░██ ░██   ░██   ░██    ░██ ░██    ░██ ░██ ░██░██    ░██ ░██  o░███      ░██ 
-  ░█████░█ ░██ ░██   ░████   ░███████  ░██    ░██ ░██ ░██░██    ░██  ░█████░██ ░███████  
-                                                                           ░██            
-                                                                     ░███████             
-
-                        Every language game breeds monsters.
-```
-
-`Glitchlings` are **utilities for corrupting the text inputs to your language models in deterministic, _linguistically principled_** ways.  
-Each embodies a different way that documents can be compromised in the wild.
-
-If reinforcement learning environments are games, then `Glitchling`s are enemies to breathe new life into old challenges.
-
-They do this by breaking surface patterns in the input while keeping the target output intact.
-
-Some `Glitchling`s are petty nuisances. Some `Glitchling`s are eldritch horrors.  
-Together, they create truly nightmarish scenarios for your language models.
-
-After all, what good is general intelligence if it can't handle a little chaos?
-
--_The Curator_
-
-## Quickstart
-
-```python
-from glitchlings import summon, SAMPLE_TEXT
-
-gaggle = summon(["reduple", "mim1c", "typogre", "rushmore"])
-gaggle(SAMPLE_TEXT)
-```
-
-> Onҽ m‎ھ‎rning, wһen Gregor Samƽa woke from trouble𝐝 𝑑reams, he found himself transformed in his bed into a horrible vermin‎٠‎ He l   lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightlh domed and divided by arches ino stiff sections. The bedding was adly able to cover it and and seemed ready to slide off any  moment. His many legxs, pitifully thin compared with the size of the the rest of him, waved about helplessly ashe looked looked.
-
-## Motivation
-
-If your model performs well on a particular task, but not when `Glitchling`s are present, it's a sign that it hasn't actually generalized to the problem.
-
-Conversely, training a model to perform well in the presence of the types of perturbations introduced by `Glitchling`s should help it generalize better.
-
-## Your First Battle
-
-Summon your chosen `Glitchling` (_or a few, if ya nasty_) and call it on your text or slot it into `Dataset.map(...)`, supplying a seed if desired.  
-Some `Glitchling`s may have additional keyword arguments but they will always be optional with what I decide are "reasonable defaults".  
-Seed defaults to 151, obviously.
-
-Calling a `Glitchling` on a `str` transparently calls `.corrupt(str, ...) -> str`.  
-This means that as long as your glitchlings get along logically, they play nicely with one another.
-
-When summoned as a `Gaggle`, the `Glitchling`s will automatically order themselves into attack waves, based on the scope of the change they make:
-
-1. Document
-2. Paragraph
-3. Sentence
-4. Word
-5. Character
-
-They're horrible little gremlins, but they're not _unreasonable_.
-
-## Starter 'lings
-
-For maintainability reasons, all `Glitchling` have consented to be given nicknames once they're in your care. See the [Monster Manual](MONSTER_MANUAL.md) for a complete bestiary.
-
-### Typogre
-
-_What a nice word, would be a shame if something happened to it._
-
-> _**Fatfinger.**_ Typogre introduces character-level errors (duplicating, dropping, adding, or swapping) based on the layout of a (currently QWERTY) keyboard.
->
-> Args
->
-> - `max_change_rate (float)`: The maximum number of edits to make as a percentage of the length (default: 0.02, 2%).
-> - `preserve_first_last (bool)`: Avoid editing the first and last character of a word (default: False).
-> - `keyboard (str)`: Keyboard layout key-neighbor map to use (default: "CURATOR_QWERTY").
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Mim1c
-
-_Wait, was that...?_
-
-> _**Confusion.**_ Mim1c replaces non-space characters with Unicode Confusables, characters that are distinct but would not usually confuse a human reader.
->
-> Args
->
-> - `replacement_rate (float)`: The maximum proportion of characters to replace (default: 0.02, 2%).
-> - `classes (list[str] | "all")`: Restrict replacements to these Unicode script classes (default: ["LATIN", "GREEK", "CYRILLIC"]).
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Scannequin
-
-_How can a computer need reading glasses?_
-
-> _**OCR Artifacts.**_ Scannequin mimics optical character recognition errors by swapping visually similar character sequences (like rn↔m, cl↔d, O↔0, l/I/1).
->
-> Args
->
-> - `error_rate (float)`: The maximum proportion of eligible confusion spans to replace (default: 0.02, 2%).
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Jargoyle
-
-_Uh oh. The worst person you know just bought a thesaurus._
-
-> _**Sesquipedalianism.**_ Jargoyle, the insufferable `Glitchling`, replaces nouns with synonyms at random, without regard for connotational or denotational differences.
->
-> Args
->
-> - `replacement_rate (float)`: The maximum proportion of words to replace (default: 0.1, 10%).
-> - `part_of_speech`: The WordNet part of speech to target (default: nouns). Accepts `wn.NOUN`, `wn.VERB`, `wn.ADJ`, or `wn.ADV`.
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Reduple
-
-_Did you say that or did I?_
-
-> _**Broken Record.**_ Reduple stutters through text by randomly reduplicating words. Like a nervous speaker, it creates natural repetitions that test a model's ability to handle redundancy without losing the thread.
->
-> Args
->
-> - `reduplication_rate (float)`: The maximum proportion of words to reduplicate (default: 0.05, 5%).
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Rushmore
-
-_I accidentally an entire word._
-
-> _**Hasty Omission.**_ The evil (?) twin of `reduple`, Rushmore moves with such frantic speed that it causes words to simply vanish from existence as it passes.
->
-> Args
->
-> - `max_deletion_rate (float)`: The maximum proportion of words to delete (default: 0.01, 1%).
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-### Redactyl
-
-_Oops, that was my black highlighter._
-
-> _**FOIA Reply.**_ Redactyl obscures random words in your document like an NSA analyst with a bad sense of humor.
->
-> ### Args
->
-> - `replacement_char (str)`: The character to use for redaction (default: █).
-> - `redaction_rate (float)`: The maximum proportion of words to redact (default: 0.05, 5%).
-> - `merge_adjacent (bool)`: Whether to redact the space between adjacent redacted words (default: False).
-> - `seed (int)`: The random seed for reproducibility (default: 151).
-
-## Field Report: Uncontained Specimens
-
-### _Containment procedures pending_
-
-- `ekkokin` substitutes words with homophones (phonetic equivalents).
-- `nylingual` backtranslates portions of text.
-- `glothopper` introduces code-switching effects, blending languages or dialects.
-- `palimpsest` rewrites, but leaves accidental traces of the past.
-- `vesuvius` is an apocryphal `Glitchling` with ties to _[Nosy, aren't we? -The Curator]_
-
-## Apocrypha
-
-Cave paintings and oral tradition contain many depictions of strange, otherworldly `Glitchling`s.  
-These _Apocryphal `Glitchling`_ are said to possess unique abilities or behaviors.  
-If you encounter one of these elusive beings, please document your findings and share them with _The Curator_.
-
-### Reproducible Corruption
-
-Every `Glitchling` owns its own independent `random.Random` instance. That means:
-
-- No `random.seed(...)` calls touch Python's global RNG.
-- Supplying a `seed` when you construct a `Glitchling` (or when you `summon(...)`) makes its behavior reproducible.
-- Re-running a `Gaggle` with the same master seed and the same input text (_and same external data!_) yields identical corruption output.
-- Corruption functions are written to accept an `rng` parameter internally so that all randomness is centralized and testable.
-
-#### Caveats
-
-- If you mutate a glitchling's parameters after you've used it (e.g. `typogre.set_param(...)`) the outputs may not be the same as before the change. So don't do that.
-
-#### At Wits' End?
-
-If you're trying to add a new glitchling and can't seem to make it deterministic, here are some places to look for determinism-breaking code:
-
-1. Search for any direct calls to `random.choice`, `random.shuffle`, or `set(...)` ordering without going through the provided `rng`.
-2. Ensure you sort collections before shuffling or sampling.
-3. Make sure indices are chosen from a stable reference (e.g., original text) when applying length‑changing edits.
-4. Make sure there are enough sort keys to maintain stability.

glitchlings-0.1.0/RELEASE.md

@@ -1,47 +0,0 @@
-# Releasing glitchlings to PyPI
-
-This project is configured to publish to PyPI via GitHub Actions when you push a version tag.
-
-## 1) One-time setup
-
-- Decide publishing auth method:
-  - Preferred: PyPI Trusted Publishing using OIDC. Enable it for the `glitchlings` project in PyPI and grant the GitHub repo `osoleve/glitchlings` permission.
-  - Alternative: Create a PyPI token (scoped to the project) and add it as a repository secret `PYPI_API_TOKEN`.
-- (Optional) Add `TEST_PYPI_API_TOKEN` if you want automatic TestPyPI uploads on pushes to `trunk`.
-
-## 2) Versioning
-
-- Update `version` in `pyproject.toml`.
-- Follow SemVer tags like `v0.1.1`.
-
-## 3) Dry-run on TestPyPI (optional)
-
-- Push to `trunk`. If `TEST_PYPI_API_TOKEN` is set, a wheel and sdist will be uploaded to TestPyPI automatically.
-
-## 4) Publish to PyPI
-
-- Create and push a tag from the repository root:
-
-  ```pwsh
-  git tag v0.1.1
-  git push origin v0.1.1
-  ```
-
-- The workflow `.github/workflows/publish.yml` will build the package from the `glitchlings/` directory and publish the artifacts to PyPI.
-
-## 5) Verify
-
-- Check the run in GitHub Actions.
-- Verify the release on PyPI project page.
-
-## Notes
-
-- The package uses Hatchling and includes a console script `glitchlings` that runs `glitchlings.main:main`.
-- Build locally:
-
-  ```pwsh
-  python -m pip install --upgrade build
-  python -m build glitchlings
-  ```
-
-- If adding new modules, ensure they live under the `glitchlings/` directory so they are included in the wheel.