Metadata-Version: 2.4
Name: caesar-cipher-tool
Version: 1.0.1
Summary: Reusable Caesar cipher module for educational purposes
Author: Gabriel Dakinah Vincent
License: MIT License
        
        Copyright (c) 2026 Gabriel Dakinah Vincent
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
Project-URL: Source, https://github.com/Gabriel-Dakinah-Vincent/caesar-cipher-tool.git
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Education
Classifier: Topic :: Security :: Cryptography
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Caesar Cipher Tool

A lightweight, reusable Caesar cipher library for Python.

> ⚠️ **Security Notice**  
> This library is for educational purposes only. It is **not cryptographically secure** and should **not** be used for sensitive data.

## Installation

```bash
pip install caesar-cipher-tool
```

## Usage

```python
from cipher_tool import encrypt, decrypt

# Encrypt a message
ciphertext = encrypt("Hello, World!", shift=3)
print(ciphertext)  # Khoor, Zruog!

# Decrypt a message
plaintext = decrypt(ciphertext, shift=3)
print(plaintext)   # Hello, World!
```

## Features

- **Simple API**: Easy-to-use encrypt/decrypt functions
- **Configurable shift**: Support for any shift value (0-25)
- **Case preservation**: Maintains uppercase and lowercase letters
- **Non-alphabetic handling**: Preserves punctuation, spaces, and numbers
- **Lightweight**: Minimal dependencies
- **Extensible**: Clean architecture for adding other cipher methods

## API Reference

### `encrypt(text, shift)`

Encrypts plaintext using Caesar cipher.

**Parameters:**
- `text` (str): The plaintext to encrypt
- `shift` (int): Number of positions to shift (0-25)

**Returns:** Encrypted ciphertext (str)

### `decrypt(text, shift)`

Decrypts ciphertext using Caesar cipher.

**Parameters:**
- `text` (str): The ciphertext to decrypt
- `shift` (int): Number of positions to shift (0-25)

**Returns:** Decrypted plaintext (str)

## Examples

```python
# Basic usage
encrypt("Hello", 3)      # "Khoor"
decrypt("Khoor", 3)      # "Hello"

# Mixed case and punctuation
encrypt("Hello, World!", 13)  # "Uryyb, Jbeyq!"

# Numbers and symbols are preserved
encrypt("Test123!", 5)        # "Yjxy123!"
```

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.
