caesarcipher 1.0

Command Line

Encoding a message:

$ caesarcipher --encode "This is a message I want to encode."

Encoding a message with a specific offset:

$ caesarcipher --offset 14 --encode "This is a message I want to encode."

Decoding a ciphertext with a specific offset:

$ caesarcipher --offset 14 --decode "W kobh hc sbqcrs hvwg ghfwbu."

Cracking a ciphertext without knowing the offset:

$ caesarcipher --crack "W kobh hc sbqcrs hvwg ghfwbu."

Library

Encoding a message:

>>> from caesarcipher import CaesarCipher
>>> cipher = CaesarCipher('I want to encode this string')
>>> cipher.encoded
'W kobh hc sbqcrs hvwg ghfwbu.'

Encoding a message with a specific offset:

>>> from caesarcipher import CaesarCipher
>>> cipher = CaesarCipher('I want to encode this string.',
...     offset=14)
>>> cipher.encoded
'W kobh hc sbqcrs hvwg ghfwbu.'

Decoding a ciphertext with a specific offset:

>>> from caesarcipher import CaesarCipher
>>> cipher = CaesarCipher('W kobh hc sbqcrs hvwg ghfwbu.',
...    offset=14)
>>> cipher.decoded
'I want to encode this string.'

Cracking a ciphertext without knowing the offset:

>>> from caesarcipher import CaesarCipher
>>> cipher = CaesarCipher('W kobh hc sbqcrs hvwg ghfwbu.')
>>> cipher.cracked
'I want to encode this string.'

Hacking

To hack on the project, clone the GitHub repo:

$ git clone https://github.com/RobSpectre/Caesar-Cipher.git

Then install in a virtualenv.

$ pip install -e ./

Tests

The project uses Nose for tests. Simply run from the project root.

$ nosetests -v

Go ahead and check on coverage and PEP8 while you’re at it!

$ nosetests -v --with-coverage --with-tissue