ciphers-vbcd 0.1.1

A tool for ciphering messages using various algorithms

Ciphers

A Python tool for ciphering messages using various algorithms.

Installation

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 .

Using pip

pip install -e .

Usage

# 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!"

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

Supported Algorithms

• Caesar Cipher: A simple substitution cipher where each letter is shifted by a fixed number of positions.