recode-stamper 0.1.2__tar.gz → 0.1.4__tar.gz

{recode_stamper-0.1.2/recode_stamper.egg-info → recode_stamper-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recode-stamper
-Version: 0.1.2
+Version: 0.1.4
 Summary: Encode and decode UTF-8 strings into a 12- or 24-word RECODE mnemonic.
 Author-email: avra911 <java-hug-circulate@duck.com>
 License: MIT License
@@ -46,7 +46,7 @@ A small Python utility that encodes UTF-8 text into a 12- or 24-word mnemonic (R
 pip install recode-stamper==0.1.2
 ```
 
-## How to run
+## Quick start
 
 After installation, use the CLI entry point:
 
@@ -65,6 +65,15 @@ recode encode "MyPassword123!"
 recode decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+For interactive use, the CLI can also prompt for text securely without echoing it in the terminal:
+
+```bash
+recode --encode
+recode encode
+```
+
+This is useful for avoiding accidental exposure in shell history or terminal logs.
+
 Show help:
 
 ```bash
@@ -78,6 +87,33 @@ python recode.py --encode "MyPassword123!"
 python recode.py --decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+## How the format works
+
+The RECODE format uses a fixed 4096-word list.
+
+- Each word is mapped to a 12-bit value
+- 2^12 = 4096 unique values
+- A word index is therefore a number from 0 to 4095
+
+The format automatically selects between 12 and 24 words:
+
+- up to 16 bytes of data -> 12 words
+- 17 to 32 bytes of data -> 24 words
+- more than 32 bytes -> rejected
+
+This keeps the output compact while preserving enough space for metadata and a checksum.
+
+You can also force the format explicitly:
+
+```bash
+recode --encode "MyPassword123!" --plates 12
+recode --encode "MyPassword123!" --plates 24
+```
+
+## Why UTF-8
+
+The encoder accepts UTF-8 text and converts it to bytes before packing the bit stream. This means it works for regular ASCII strings as well as non-ASCII text, while preserving deterministic behavior and a fixed wordlist layout.
+
 ## Wordlist source
 
 The file `wordlist4096.txt` is based on the public wordlist from:

{recode_stamper-0.1.2 → recode_stamper-0.1.4}/README.md

@@ -8,7 +8,7 @@ A small Python utility that encodes UTF-8 text into a 12- or 24-word mnemonic (R
 pip install recode-stamper==0.1.2
 ```
 
-## How to run
+## Quick start
 
 After installation, use the CLI entry point:
 
@@ -27,6 +27,15 @@ recode encode "MyPassword123!"
 recode decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+For interactive use, the CLI can also prompt for text securely without echoing it in the terminal:
+
+```bash
+recode --encode
+recode encode
+```
+
+This is useful for avoiding accidental exposure in shell history or terminal logs.
+
 Show help:
 
 ```bash
@@ -40,6 +49,33 @@ python recode.py --encode "MyPassword123!"
 python recode.py --decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+## How the format works
+
+The RECODE format uses a fixed 4096-word list.
+
+- Each word is mapped to a 12-bit value
+- 2^12 = 4096 unique values
+- A word index is therefore a number from 0 to 4095
+
+The format automatically selects between 12 and 24 words:
+
+- up to 16 bytes of data -> 12 words
+- 17 to 32 bytes of data -> 24 words
+- more than 32 bytes -> rejected
+
+This keeps the output compact while preserving enough space for metadata and a checksum.
+
+You can also force the format explicitly:
+
+```bash
+recode --encode "MyPassword123!" --plates 12
+recode --encode "MyPassword123!" --plates 24
+```
+
+## Why UTF-8
+
+The encoder accepts UTF-8 text and converts it to bytes before packing the bit stream. This means it works for regular ASCII strings as well as non-ASCII text, while preserving deterministic behavior and a fixed wordlist layout.
+
 ## Wordlist source
 
 The file `wordlist4096.txt` is based on the public wordlist from:

{recode_stamper-0.1.2 → recode_stamper-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "recode-stamper"
-version = "0.1.2"
+version = "0.1.4"
 description = "Encode and decode UTF-8 strings into a 12- or 24-word RECODE mnemonic."
 readme = "README.md"
 requires-python = ">=3.9"

{recode_stamper-0.1.2 → recode_stamper-0.1.4}/recode_stamper/__init__.py

@@ -15,6 +15,7 @@ The script encodes UTF-8 text into a 12- or 24-word mnemonic and decodes it back
 import argparse
 import hashlib
 from pathlib import Path
+import getpass
 
 
 class Recode:
@@ -675,6 +676,24 @@ def parse_mnemonic_input(raw_text):
     ]
 
 
+def prompt_mnemonic_input():
+    """Prompt for each mnemonic word without echoing it."""
+
+    raw_count = input("Number of mnemonic words (12 or 24): ")
+    try:
+        word_count = int(raw_count)
+    except ValueError:
+        raise ValueError("Mnemonic must contain 12 or 24 words")
+
+    if word_count not in (12, 24):
+        raise ValueError("Mnemonic must contain 12 or 24 words")
+
+    return [
+        getpass.getpass(f"Word {position}/{word_count}: ")
+        for position in range(1, word_count + 1)
+    ]
+
+
 def build_parser():
     """Create the command-line parser."""
 
@@ -685,6 +704,8 @@ def build_parser():
     parser.add_argument(
         "--encode",
         dest="encode_text",
+        nargs="?",
+        const="",
         help="UTF-8 string to encode into mnemonic words",
         metavar="TEXT",
     )
@@ -692,6 +713,8 @@ def build_parser():
     parser.add_argument(
         "--decode",
         dest="decode_text",
+        nargs="?",
+        const="",
         help="Mnemonic phrase to decode back into a UTF-8 string",
         metavar="TEXT",
     )
@@ -700,7 +723,7 @@ def build_parser():
         "--plates",
         type=int,
         choices=(12, 24),
-        help="Force 12 or 24 plates when encoding",
+        help="Force 12 or 24 plates when encoding, or use it during decoding to avoid prompting",
     )
 
     subparsers = parser.add_subparsers(
@@ -713,6 +736,7 @@ def build_parser():
     )
     encode_parser.add_argument(
         "text",
+        nargs="?",
         help="UTF-8 string to encode",
     )
     encode_parser.add_argument(
@@ -728,20 +752,64 @@ def build_parser():
     )
     decode_parser.add_argument(
         "text",
+        nargs="?",
         help="Mnemonic words separated by spaces",
     )
+    decode_parser.add_argument(
+        "--plates",
+        type=int,
+        choices=(12, 24),
+        help="Force 12 or 24 plates when decoding to avoid prompting",
+    )
 
     return parser
 
 
+def _normalize_flagged_text_args(argv):
+    """Reorder --encode/--decode with --plates so the text stays attached to the flag."""
+
+    if argv is None:
+        return None
+
+    args = list(argv)
+    i = 0
+    while i < len(args) - 3:
+        flag = args[i]
+        if flag in ("--encode", "--decode") and args[i + 1] == "--plates":
+            plates_value = args[i + 2]
+            text_value = args[i + 3]
+
+            if text_value.startswith("-"):
+                i += 1
+                continue
+
+            args = (
+                args[:i]
+                + [flag, text_value, "--plates", plates_value]
+                + args[i + 4 :]
+            )
+            i += 1
+        else:
+            i += 1
+
+    return args
+
+
 def main(argv=None):
     """Run the CLI."""
 
     parser = build_parser()
+    argv = _normalize_flagged_text_args(argv)
     args = parser.parse_args(argv)
 
     if args.command == "encode":
         text = args.text
+        if text is None:
+            text = getpass.getpass("Text to encode: ")
+            confirmation = getpass.getpass("Confirm text to encode: ")
+            if text != confirmation:
+                print("Error: input values do not match.")
+                return 1
         plates = args.plates
         mnemonic = r.encode(
             text.encode("utf-8"),
@@ -751,21 +819,63 @@ def main(argv=None):
         return 0
 
     if args.command == "decode":
-        mnemonic = parse_mnemonic_input(args.text)
+        text = args.text
+        if text is None:
+            if args.plates is not None:
+                word_count = args.plates
+                mnemonic = [
+                    getpass.getpass(f"Word {position}/{word_count}: ")
+                    for position in range(1, word_count + 1)
+                ]
+            else:
+                mnemonic = prompt_mnemonic_input()
+        else:
+            mnemonic = parse_mnemonic_input(text)
+            if args.plates is not None and len(mnemonic) != args.plates:
+                raise ValueError(
+                    f"Provided mnemonic has {len(mnemonic)} words but --plates={args.plates} expects {args.plates}"
+                )
+        if args.plates is not None and len(mnemonic) != args.plates:
+            raise ValueError(
+                f"Provided mnemonic has {len(mnemonic)} words but --plates={args.plates} expects {args.plates}"
+            )
         decoded = r.decode(mnemonic).decode("utf-8")
         print(decoded)
         return 0
 
     if args.encode_text is not None:
+        if args.encode_text == "":
+            text = getpass.getpass("Text to encode: ")
+            confirmation = getpass.getpass("Confirm text to encode: ")
+            if text != confirmation:
+                print("Error: input values do not match.")
+                return 1
+        else:
+            text = args.encode_text
         mnemonic = r.encode(
-            args.encode_text.encode("utf-8"),
+            text.encode("utf-8"),
             plates=args.plates,
         )
         print(" ".join(mnemonic))
         return 0
 
     if args.decode_text is not None:
-        mnemonic = parse_mnemonic_input(args.decode_text)
+        text = args.decode_text
+        if text == "":
+            if args.plates is not None:
+                word_count = args.plates
+                mnemonic = [
+                    getpass.getpass(f"Word {position}/{word_count}: ")
+                    for position in range(1, word_count + 1)
+                ]
+            else:
+                mnemonic = prompt_mnemonic_input()
+        else:
+            mnemonic = parse_mnemonic_input(text)
+        if args.plates is not None and len(mnemonic) != args.plates:
+            raise ValueError(
+                f"Provided mnemonic has {len(mnemonic)} words but --plates={args.plates} expects {args.plates}"
+            )
         decoded = r.decode(mnemonic).decode("utf-8")
         print(decoded)
         return 0

{recode_stamper-0.1.2 → recode_stamper-0.1.4/recode_stamper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: recode-stamper
-Version: 0.1.2
+Version: 0.1.4
 Summary: Encode and decode UTF-8 strings into a 12- or 24-word RECODE mnemonic.
 Author-email: avra911 <java-hug-circulate@duck.com>
 License: MIT License
@@ -46,7 +46,7 @@ A small Python utility that encodes UTF-8 text into a 12- or 24-word mnemonic (R
 pip install recode-stamper==0.1.2
 ```
 
-## How to run
+## Quick start
 
 After installation, use the CLI entry point:
 
@@ -65,6 +65,15 @@ recode encode "MyPassword123!"
 recode decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+For interactive use, the CLI can also prompt for text securely without echoing it in the terminal:
+
+```bash
+recode --encode
+recode encode
+```
+
+This is useful for avoiding accidental exposure in shell history or terminal logs.
+
 Show help:
 
 ```bash
@@ -78,6 +87,33 @@ python recode.py --encode "MyPassword123!"
 python recode.py --decode "artist scavenge intimate airdrop humdrum curfew hexagon candy comedy bunion brevity aardvark"
 ```
 
+## How the format works
+
+The RECODE format uses a fixed 4096-word list.
+
+- Each word is mapped to a 12-bit value
+- 2^12 = 4096 unique values
+- A word index is therefore a number from 0 to 4095
+
+The format automatically selects between 12 and 24 words:
+
+- up to 16 bytes of data -> 12 words
+- 17 to 32 bytes of data -> 24 words
+- more than 32 bytes -> rejected
+
+This keeps the output compact while preserving enough space for metadata and a checksum.
+
+You can also force the format explicitly:
+
+```bash
+recode --encode "MyPassword123!" --plates 12
+recode --encode "MyPassword123!" --plates 24
+```
+
+## Why UTF-8
+
+The encoder accepts UTF-8 text and converts it to bytes before packing the bit stream. This means it works for regular ASCII strings as well as non-ASCII text, while preserving deterministic behavior and a fixed wordlist layout.
+
 ## Wordlist source
 
 The file `wordlist4096.txt` is based on the public wordlist from: