Metadata-Version: 2.1
Name: runigma
Version: 2019.3
Summary: RuNigma is a fictional cypher machine inspired by World War 2s Enigma Machines.
Home-page: https://github.com/vd2org/runigma
Author: Vd
Author-email: vd@vd2.org
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications
Classifier: Topic :: Security
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities

# periodic

RuNigma is a fictional cypher machine inspired by World War 2's Enigma Machines.

# Setup

```bash
pip install runigma
```


# Example usage

```python
from runigma import RuNigmaMachine

rotors = 'Ё Ь Д Н Й'
reflector = 'Ш'
ring_settings = 'a _ y g Б'
plugboard_settings = 'xЕ hЬ КМ Тn iЗ АЛ ЮЫ Бt z8 ОШ wЯ y0 a7 4Ъ СЖ p6 Эe g_ 2b dc'

machine = RuNigmaMachine.from_key_sheet(rotors=rotors, reflector=reflector, ring_settings=ring_settings,
                                        plugboard_settings=plugboard_settings)

machine.set_display('ЯХ3ОЪ')

crypted = machine.process_text('hello world')

print(crypted)
# displays: БЮУЦwЛgcЭЕМ
```

# Command line tools

## runigma

This tool can be used for encipher and decipher text.

```bash
runigma --key-file=enigma.keys -s ФСИАР -t HELLOXWORLDX
```

```bash
runigma -r A Б В Г Д -i a b c d -p AB CD EF GH IJ KL MN -u Ф -s АУГСД
```

## runigma-sheet

This tool can be used for generate new key sheet file.

```bash
runigma-sheet > keysheet.txt
```


