<commit_before>=====
 VIC
=====

This is a Python 3 implementation of the pen-and-paper cipher used by the Soviet spy Reino Häyhänen, codenamed "VICTOR", in the 1950s.

If you have 3to2 from the PyPI installed you can just run ``make 3to2`` and you will end up with a copy of the cipher implementation in the ``3to2/`` subdirectory converted to run under Python 2.


Usage
=====

The ``main.py`` script has two subcommands, ``encrypt`` and ``decrypt``.  To encrypt something you have to pass the following as arguments to the ``encrypt`` subcommand:

1. A 10 character key for the straddling checkerboard, with two of those characters being spaces that are used for the second and third layer of the checkerboard.
2. A 5 digit unique and random message ID.
3. A 20 character passphrase used to derive keys.
4. A date used to derive keys and to insert the message ID into the ciphertext. (``DDMMYYYY``)
5. A 1 or 2 digit personal identifier, unique per person.
6. A cleartext message to encrypt.


To decrypt a message you have to pass the following as arguments to the ``decrypt`` subcommand:

1. A 10 character key for the straddling checkerboard, with two of those characters being spaces that are used for the second and third layer of the checkerboard.
2. A 20 character passphrase used to derive keys.
3. A date used to derive keys and to insert the message ID into the ciphertext. (``DDMMYYYY``)
4. A 1 or 2 digit personal identifier, unique per person.
5. A cleartext message to encrypt.
<commit_msg>README.rst: main.py -> vic<commit_after>=====
 VIC
=====

This is a Python 3 implementation of the pen-and-paper cipher used by the Soviet spy Reino Häyhänen, codenamed "VICTOR", in the 1950s.

If you have 3to2 from the PyPI installed you can just run ``make 3to2`` and you will end up with a copy of the cipher implementation in the ``3to2/`` subdirectory converted to run under Python 2.


Usage
=====

The ``vic`` entrypoint has two subcommands, ``encrypt`` and ``decrypt``.  To encrypt something you have to pass the following as arguments to the ``encrypt`` subcommand:

1. A 10 character key for the straddling checkerboard, with two of those characters being spaces that are used for the second and third layer of the checkerboard.
2. A 5 digit unique and random message ID.
3. A 20 character passphrase used to derive keys.
4. A date used to derive keys and to insert the message ID into the ciphertext. (``DDMMYYYY``)
5. A 1 or 2 digit personal identifier, unique per person.
6. A cleartext message to encrypt.


To decrypt a message you have to pass the following as arguments to the ``decrypt`` subcommand:

1. A 10 character key for the straddling checkerboard, with two of those characters being spaces that are used for the second and third layer of the checkerboard.
2. A 20 character passphrase used to derive keys.
3. A date used to derive keys and to insert the message ID into the ciphertext. (``DDMMYYYY``)
4. A 1 or 2 digit personal identifier, unique per person.
5. A cleartext message to encrypt.

{'fraction_non_alphanumeric': 0.06607201850016518, 'fraction_numerical': 0.023785926660059464, 'mean_word_length': 4.097643097643098, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5640228', 'n_tokens_mistral': 887, 'n_tokens_neox': 822, 'n_words': 506}