nyu-caesar-crypt-mar242024 0.1.6
A caesar crypt package
Requires Python: >=3

![Python build & test](https://github.com/software-students-spring2024/3-python-package-exercise-ja-ia/actions/workflows/event-logger.yml/badge.svg)

# Project Description
Our project is a Caesar cipher package intended to help encrypt messages for users.

# Documentation

## Functions

caesar_encrypt(text, shift)

    Given given text of alphanumerical characters, return a Caesar cipher with a specified shift amount. Shift must be positive number

    :param text: The input string to encrypt.
    :param shift: The number of positions to shift each character.
    :return: The encrypted string.

caesar_decrypt(text, shift)

    Given given Caeser cipher of alphanumerical characters, return unencrypted message if you have the original shift amount. Shift must be a positive number.
       
    :param text: The input string to decrypt.
    :param shift: The number of positions the characters were shifted to encrypt.
    :return: The decrypted string.

brute_force_decrypt(encrypted_text)

    Possibly decrypts alphanumeric Caesar cipher by going through all of the possible shift amounts. Return every possible shift amount

    :param encrypted_text: The encrypted message to decrypt.
    :return: A dictionary of all possible shifts and their corresponding decrypted messages.

verify_encryption_decryption(original_text, decrypted_text):

    Verifies that the original plaintext matches the decrypted text,
indicating the encryption and decryption processes are inverses of each other.

    :param original_text: The original plaintext before encryption.
    :param decrypted_text: The text after being encrypted and then decrypted.
    :return: True if the original and decrypted texts match, False otherwise.


# Installation

To install, just use pip to install from PyPI:

`` pip install -i https://test.pypi.org/simple/ nyu_caesar_crypt_mar24==0.1.6 ``



To import the code, here's the basic program we created with it: [main.py](https://github.com/software-students-spring2024/3-python-package-exercise-ja-ia/blob/main/src/nyu_caesar_crypt_mar24/__main__.py)

If you'd like to contribute to our project you'll likely need to prepare a few more things:

## Virtual environment

You can think of a virtual environment as an independent, smaller computer inside your computer. Any changes to the virtual environment will be isolated, such as installing dependencies. Our package includes any dependencies in the requirements.txt file, so you can install dependencies quickly using the command shell.

To install pipenv:
`` pip install pipenv `` 

To run your virtual environment:
`` pipenv shell ``

To install the dependencies:
`` pip install pytest build twine ``
or
`` pip install -r requirements.txt ``

## Testing

We've also included some unit tests as well. Simply run the following command in the command shell:
``python -m pytest`` or ``python3 -m pytest``

These are basic unit tests, but they should tell you if something is wrong with your package.

# Usage

Upon installation, just call *ccrypt* the program from the command line:
`` python -m ccrypt `` or ``python 3 ccrypt ``

Once the program is called, first type and enter whether you would like to (e)ncrypt, (d)ecrypt, or (b)rute-force (note that only an encryption up to 26 is allowed).

If encrypt, then simply enter the text you would like to encrypt as the first parameter and the amount you'd like each character shifted as the second parameter. The program will then output the Caesar cipher.

If decrypt, then simply enter the text you would like to know as the first parameter and the amount you know each character shifted as the second parameter. The program will then output the original text. Make sure you remember the shift for any encrypted message you create.

If brute-force, then the program will iterate through all of the possible shifts and output all of the results.

# Contributors

- [Alex Kondratiuk](https://github.com/ak8000)
- [Janet Pan](https://github.com/jp6024)
- [Isaac Kwon](https://github.com/iok206)
- [Adam Schwartz](https://github.com/aschwartz01)

# PyPI page
- [Caesar Crypt](https://pypi.org/project/nyu-caesar-crypt-mar24/0.1.6)