{ "info": { "author": "Rob Spectre", "author_email": "rob@brooklynhacker.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Security :: Cryptography" ], "description": "***************\nCaesar Cipher\n***************\n\nA Python package and command line script for encoding, decoding and cracking\nmessages with the `Caesar Shift Cipher`_.\n\n.. image:: https://travis-ci.org/RobSpectre/Caesar-Cipher.svg?branch=master\n :target: https://travis-ci.org/RobSpectre/Caesar-Cipher\n\n.. image:: https://coveralls.io/repos/RobSpectre/Caesar-Cipher/badge.png?branch=master\n :target: https://coveralls.io/r/RobSpectre/Caesar-Cipher?branch=master\n\n**Table of Contents**\n\n\n.. contents::\n :local:\n :depth: 1\n :backlinks: none\n\n\nFeatures\n============\n\n* Encoding\n* Decoding\n* Cracking (decoding ciphertext without known offset)\n* Arbitrary cipher offsets\n* Command Line Interface\n* Test suite\n* Support for both Python 2 and 3\n* `PEP8`_. Praise the Dark Lord\n\n\nInstallation\n============\n\nThe latest version can be installed via `pip`_.\n\n.. code-block:: bash\n\n $ pip install caesarcipher\n\nIf that doesn't work, give ``easy_install`` a try:\n\n.. code-block:: bash\n\n $ easy_install caesarcipher\n\n\nUsage\n===========\n\nCommand Line\n------------\n\nEncoding a message:\n\n.. code-block:: bash\n\n $ caesarcipher --encode \"This is a message I want to encode.\"\n\nEncoding a message with a specific offset:\n\n.. code-block:: bash\n\n $ caesarcipher --offset 14 --encode \"This is a message I want to encode.\"\n\nDecoding a ciphertext with a specific offset:\n\n.. code-block:: bash\n\n $ caesarcipher --offset 14 --decode \"W kobh hc sbqcrs hvwg ghfwbu.\"\n\nCracking a ciphertext without knowing the offset:\n\n.. code-block:: bash\n\n $ caesarcipher --crack \"W kobh hc sbqcrs hvwg ghfwbu.\"\n\n\nLibrary\n-------------\n\nEncoding a message:\n\n.. code-block:: python \n\n >>> from caesarcipher import CaesarCipher\n >>> cipher = CaesarCipher('I want to encode this string')\n >>> cipher.encoded\n 'W kobh hc sbqcrs hvwg ghfwbu.'\n\nEncoding a message with a specific offset:\n\n.. code-block:: python \n\n >>> from caesarcipher import CaesarCipher\n >>> cipher = CaesarCipher('I want to encode this string.',\n ... offset=14)\n >>> cipher.encoded\n 'W kobh hc sbqcrs hvwg ghfwbu.'\n\nDecoding a ciphertext with a specific offset:\n\n.. code-block:: python \n\n >>> from caesarcipher import CaesarCipher\n >>> cipher = CaesarCipher('W kobh hc sbqcrs hvwg ghfwbu.',\n ... offset=14)\n >>> cipher.decoded\n 'I want to encode this string.'\n\nCracking a ciphertext without knowing the offset:\n\n.. code-block:: python \n\n >>> from caesarcipher import CaesarCipher\n >>> cipher = CaesarCipher('W kobh hc sbqcrs hvwg ghfwbu.')\n >>> cipher.cracked\n 'I want to encode this string.'\n\n\nDevelopment\n============\n\nHacking\n----------\n\nTo hack on the project, clone the `GitHub repo`_:\n\n.. code-block:: bash\n\n $ git clone https://github.com/RobSpectre/Caesar-Cipher.git\n\nThen install in a `virtualenv`_.\n\n.. code-block:: bash\n\n $ pip install -e ./\n\n\nTests\n-----------\n\nThe project uses `Nose`_ for tests. Simply run from the project root.\n\n.. code-block:: bash\n\n $ nosetests -v\n\nGo ahead and check on coverage and PEP8 while you're at it!\n\n.. code-block:: bash\n\n $ nosetests -v --with-coverage --with-tissue\n\n\nMeta\n===========\n\n* Written by `Rob Spectre`_\n* Used for Hacker Olympics London 2014\n* Released under `MIT License`_\n* Software is as is - no warranty expressed or implied.\n* The `Caesar Shift Cipher`_ is known to be ridiculously easy to crack, as evidenced\n by this very package. Do not confuse with actual cryptography or use in\n anything that is important - it's just a fun math problem for a sunny vacation\n afternoon.\n\n.. _Caesar Shift Cipher: http://en.wikipedia.org/wiki/Caesar_cipher\n.. _pip: http://pip.readthedocs.org/en/latest/\n.. _GitHub Repo: https://github.com/RobSpectre/Caesar-Cipher\n.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\n.. _Rob Spectre: http://www.brooklynhacker.com\n.. _MIT License: http://opensource.org/licenses/MIT\n.. _Nose: https://nose.readthedocs.org/en/latest/\n.. _PEP8: http://legacy.python.org/dev/peps/pep-0008/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/RobSpectre/Caesar-Cipher", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "caesarcipher", "package_url": "https://pypi.org/project/caesarcipher/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/caesarcipher/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/RobSpectre/Caesar-Cipher" }, "release_url": "https://pypi.org/project/caesarcipher/1.0/", "requires_dist": null, "requires_python": null, "summary": "A Python package and command line script for encoding, decoding and cracking Caesar ciphers.", "version": "1.0" }, "last_serial": 1110574, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "c5cc280216f0dfbc71fef7ba9e8ef448", "sha256": "19203849fa0309fc356cac18a138726ac2463af665cb5cc20174cbae54c4b245" }, "downloads": -1, "filename": "caesarcipher-1.0.tar.gz", "has_sig": false, "md5_digest": "c5cc280216f0dfbc71fef7ba9e8ef448", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10083, "upload_time": "2014-06-01T20:23:25", "url": "https://files.pythonhosted.org/packages/fb/51/75d0cb5a391239b536869e8750e76f12df0abf7e99eccb8299d694463854/caesarcipher-1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c5cc280216f0dfbc71fef7ba9e8ef448", "sha256": "19203849fa0309fc356cac18a138726ac2463af665cb5cc20174cbae54c4b245" }, "downloads": -1, "filename": "caesarcipher-1.0.tar.gz", "has_sig": false, "md5_digest": "c5cc280216f0dfbc71fef7ba9e8ef448", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10083, "upload_time": "2014-06-01T20:23:25", "url": "https://files.pythonhosted.org/packages/fb/51/75d0cb5a391239b536869e8750e76f12df0abf7e99eccb8299d694463854/caesarcipher-1.0.tar.gz" } ] }