Ciphers

A Python tool for ciphering messages using various algorithms.

Installation

Basic Installation

pip install ciphers-vbc

With RSA Support

pip install ciphers-vbc[rsa]

Using uv (recommended)

# Install uv if you don't have it
pip install uv

# Create and activate a virtual environment with uv
uv venv
source .venv/bin/activate  # On Linux/macOS
# or
# .venv\Scripts\activate  # On Windows

# Install the package in development mode
uv pip install -e .

# With RSA support
uv pip install -e ".[rsa]"

Using pip

pip install -e .

# With RSA support
pip install -e ".[rsa]"

Usage

Caesar Cipher

# Encrypt a message using Caesar cipher with a shift of 3
cipher encrypt --algorithm caesar --key 3 "Hello, World!"

# Decrypt a message using Caesar cipher with a shift of 3
cipher decrypt --algorithm caesar --key 3 "Khoor, Zruog!"

RSA Cipher

First, generate an RSA key pair:

# Using OpenSSL
openssl genrsa -out private_key.pem 2048
openssl rsa -in private_key.pem -pubout -out public_key.pem

Then encrypt and decrypt messages:

# Encrypt a message using RSA with a public key
cipher encrypt --algorithm rsa --key public_key.pem "Secret message"

# Decrypt a message using RSA with a private key
cipher decrypt --algorithm rsa --key private_key.pem "encrypted_message_here"

Development

Installing Development Dependencies

With uv:

# Install development dependencies
uv pip install -e ".[dev]"

With pip:

# Install development dependencies
pip install -e ".[dev]"

Running Tests

# Run tests with pytest
pytest

# Run tests with coverage
pytest --cov=ciphers

Code Formatting and Linting

# Format code with black
black .

# Sort imports with isort
isort .

# Lint with ruff
ruff check .

# Format with ruff
ruff format .

# Type checking with mypy
mypy ciphers tests

Building and Publishing

Building the package with uv:

# Build both wheel and sdist
uv build .

# Or build specific formats
uv build --wheel .  # Only wheel
uv build --sdist .  # Only source distribution

Publishing to PyPI with uv:

# Upload to TestPyPI first to verify everything works
uv publish --index testpypi dist/*

# Upload to PyPI
uv publish dist/*

You can also use twine if you prefer:

# Install twine
uv pip install twine

# Upload to TestPyPI
python -m twine upload --repository testpypi dist/*

# Upload to PyPI
python -m twine upload dist/*

Supported Algorithms

• Caesar Cipher: A simple substitution cipher where each letter is shifted by a fixed number of positions.
• RSA Cipher: A public-key cryptosystem that uses asymmetric encryption for secure data transmission.