Added codec: galactic

dhondta · dhondta · commit d8380ee4e891 · 2022-01-19T17:41:48.000+01:00
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 [![DOI](https://zenodo.org/badge/236679865.svg)](https://zenodo.org/badge/latestdoi/236679865)
 [![License](https://img.shields.io/pypi/l/codext.svg)](https://pypi.python.org/pypi/codext/)
 
-This library extends the native [`codecs`](https://docs.python.org/3/library/codecs.html) library (namely for adding new custom encodings and character mappings) and provides a myriad of new encodings (static or parametrized, like `rot` or `xor`), hence its named combining *CODecs EXTension*.
+[**CodExt**](https://github.com/dhondta/python-codext) is a (Python2-3 compatible) library that extends the native [`codecs`](https://docs.python.org/3/library/codecs.html) library (namely for adding new custom encodings and character mappings) and provides **120+ new codecs**, hence its name combining *CODecs EXTension*. It also features a **guess mode** for decoding multiple layers of encoding and **CLI tools** for convenience.
 
 ```sh
 $ pip install codext
@@ -281,6 +281,7 @@ o
 
 - [X] `braille`: well-known braille language (Python 3 only)
 - [X] `ipsum`: aka lorem ipsum
+- [X] `galactic`: aka galactic alphabet or Minecraft enchantment language (Python 3 only)
 - [X] `leetspeak`: based on minimalistic elite speaking rules
 - [X] `morse`: uses whitespace as a separator
 - [X] `navajo`: only handles letters (not full words from the Navajo dictionary)
diff --git a/codext/languages/__init__.py b/codext/languages/__init__.py
@@ -1,5 +1,6 @@
 # -*- coding: UTF-8 -*-
 from .braille import *
+from .galactic import *
 from .ipsum import *
 from .leetspeak import *
 from .morse import *
diff --git a/codext/languages/galactic.py b/codext/languages/galactic.py
@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+"""Galactic Alphabet Codec - Minecraft enchantment language content encoding.
+
+This codec:
+- en/decodes strings from str to str
+- en/decodes strings from bytes to bytes
+- decodes file content to str (read)
+- encodes file content from str to bytes (write)
+"""
+from ..__common__ import *
+
+
+__examples__ = {
+    'enc-dec(galactic|minecraft_enchanting_language)': ["test " + MASKS['l']],
+    'enc(galactic-alphabet|minecraft)':                {'Bad test#': None},
+}
+
+
+# source: https://shapecatcher.com
+ENCMAP = {
+    'a': ["ᒋ", "ᔑ"], 'b': ["⦣", "ゝ", "ʖ"], 'c': ["ì", "ᓵ"], 'd': "↸", 'e': ["ᒷ", "Ŀ"], 'f': ["𝌁", "⎓"],
+    'g': ["𐌝", "┤", "⫞", "⊣"], 'h': ["₸", "⍑", "╤"], 'i': "╎", 'j': ["⫶", "⁝", "ⵗ", "⋮"], 'k': "ꖌ", 'l': "ꖎ",
+    'm': ["ᒲ", "⟓"], 'n': ["ソ", "リ"], 'o': ["⁊", "フ", "ㇷ", "𝙹"], 'p': ["ⅱ", "ĳ", "‼", "!"],
+    'q': ["ᑑ", "⊐", "コ"], 'r': ["⸬", "∷", "⛚"], 's': ["߆", "𝈿", "ꝇ", "ᓭ"], 't': ["ℸ", "ヿ", "⅂", "Ꞁ"],
+    'u': ["⚍", "⍨"], 'v': ["𝍦", "⍊", "╧"], 'w': ["∴", "⸫", "⛬"], 'x': ["ꜘ", "╱", " ̷", "⟋"],
+    'y': ["║", "‖", "∥", "ǁ", "𝄁", "|"], 'z': ["ᑎ", "⋂", "∩", "⨅", "⛫"],
+    ' ': [" ", "⠀"],
+}
+
+
+if PY3:
+    add_map("galactic", ENCMAP, ignore_case="encode", printables_rate=0.,
+            pattern=r"^(?:galactic(?:[-_]alphabet)?|minecraft(?:[-_](?:enchantment|enchanting[-_]language))?)$")
+
diff --git a/docs/enc/languages.md b/docs/enc/languages.md
@@ -23,6 +23,23 @@ It supports letters, digits and some special characters.
 
 -----
 
+### Galactic
+
+This implements the [Minecraft's enchanting table](https://www.thegamer.com/minecraft-enchantment-table-language-guide/) using resembling Unicode characters.
+
+**Codec** | **Conversions** | **Aliases** | **Comment**
+:---: | :---: | --- | ---
+`galactic` | text <-> Minecraft enchantment symbols | `galactic-alphabet`, `minecraft_enchantment`, `minecraft-enchanting-language` | Python 3 only
+
+```python
+>>> codext.encode("this is a test", "galactic")
+'ℸ₸╎߆ ╎߆ ᒋ ℸᒷ߆ℸ'
+>>> codext.decode("ℸ₸╎߆ ╎߆ ᒋ ℸᒷ߆ℸ", "galactic")
+'this is a test'
+```
+
+-----
+
 ### Ipsum
 
 This implements a codec that uses lorem ipsum words. It selects random words per letter and keeps the following punctuations: "`.,:;+=-*/\\`".
