Skip to content

README.md

Latest commit

 

History

History
107 lines (80 loc) · 2.83 KB

README.md

File metadata and controls

107 lines (80 loc) · 2.83 KB

GitHub Description

Caesar Cipher Messenger
A simple and fun Streamlit app for encoding and decoding secret messages using the Caesar Cipher. Perfect for secure communication with friends! 🕵️‍♂️

README File

# Caesar Cipher Messenger

A Streamlit app for encoding and decoding messages using the Caesar Cipher. This app allows you and your friends to communicate secretly by shifting letters in your messages by a chosen number.

---

## Features
- **Encode Messages**: Convert your plaintext messages into secret code.
- **Decode Messages**: Decode your friend's secret messages back into plaintext.
- **Custom Shift Number**: Choose your own shift number (1–25) for added security.
- **User-Friendly Interface**: Simple and intuitive design powered by Streamlit.

---

## How It Works
The Caesar Cipher is a substitution cipher where each letter in the message is shifted by a fixed number of places down or up the alphabet. For example, with a shift of 3:
- `A` → `D`
- `B` → `E`
- `C` → `F`
- ...
- `Z` → `C`

Non-alphabetic characters (like spaces or punctuation) are left unchanged.

---

## How to Use
1. **Agree on a Shift Number**: You and your friend must agree on a secret shift number (e.g., 3).
2. **Encode Your Message**:
   - Go to the "Encode Message" tab.
   - Enter your message and click "Encode".
   - Share the encoded message with your friend.
3. **Decode Your Friend's Message**:
   - Go to the "Decode Message" tab.
   - Paste the encoded message and click "Decode".
   - Read the decoded message.

---

## Installation
1. Clone this repository:
   ```bash
   git clone https://github.com/your-username/caesar-cipher-messenger.git
  1. Navigate to the project directory: 
    cd caesar-cipher-messenger
  2. Install the required dependencies: 
    pip install streamlit

Running the App

  1. Run the Streamlit app: 
    streamlit run caesar_cipher_app.py
  2. Open your browser and go to the URL provided in the terminal (usually http://localhost:8501).

Example

  • Shift Number: 3
  • Message to Encode: HELLO BEST FRIEND
  • Encoded Message: KHOOR EHVW IULHQG
  • Decode KHOOR EHVW IULHQG: HELLO BEST FRIEND

Screenshots

Encode Tab
Encoding a message with a shift of 3.

Decode Tab
Decoding a message with a shift of 3.

Contributing

Contributions are welcome! If you have any ideas or improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

  • Inspired by the ancient Caesar Cipher.
  • Built with Streamlit.

Enjoy sending secret messages with your friends! 🕵️‍♂️