semvec/pypi-packages huggingface dataset:
ghostencoding 0.0.3
Progressive ROT + optional zlib compression -> UUID-like string
License: MIT
Requires Python: >=3.8

# GHosTEncoding

Progressive ROT encoding (default `start=21`) with optional zlib compression.  
Generates UUID-like encoded strings for lightweight **obfuscation** and **data hiding**.

---

## 🔧 Installation

```bash
pip install ghostencoding
```

---

## 🚀 Quick Example

```python
from ghostencoding import encode_pipeline, decode_pipeline

# Encode text
encoded = encode_pipeline("hello world")
print("Encoded:", encoded)

# Decode back
decoded = decode_pipeline(encoded)
print("Decoded:", decoded)
```

**Example Output:**
```
Encoded: 789cabad-5651-d5b4-32d6-31d056010011-d80283
Decoded: hello world
```

---

## ⚙️ Advanced Options

| Parameter | Type | Default | Description |
|-----------:|:----:|:--------:|-------------|
| `start` | int | `21` | Starting shift for progressive ROT |
| `alphabet_mode` | str | `"printable"` | `"printable"` (all ASCII) or `"letters"` (A–Z, a–z) |
| `compress` | bool | `True` | Enable/disable zlib compression |

---

### Example with Custom Options

```python
encoded = encode_pipeline(
    "Secret message!",
    start=10,
    alphabet_mode="letters",
    compress=False
)
print("Encoded:", encoded)

decoded = decode_pipeline(
    encoded,
    start=10,
    alphabet_mode="letters",
    compress=False
)
print("Decoded:", decoded)
```

**Example Output :**
```
Encoded: 43706f65-7369-2064-776c-6d76636221
Decoded: Secret message!
```

---

## 💡 Tips

- Compression helps for long/repetitive text; for tiny inputs it can add overhead.  
- Use `alphabet_mode="letters"` for clean, punctuation-free tokens.  
- Always use the same options for both encode/decode to ensure a correct roundtrip.


---

## 🪪 License

MIT License © 2025