Skip to main content

A command-line tool for Caesar cipher encryption and decryption

Project description

Caesar Cipher CLI Tool

A lightweight command-line tool written in Python to encrypt and decrypt text using the Caesar cipher algorithm.

This project demonstrates building, packaging, and distributing a Python CLI tool using modern Python standards.


Features

  • Encrypt and decrypt text using the Caesar cipher technique
  • Command-line interface with clear flags and help output
  • Supports custom shift values
  • Handles both encryption and decryption modes
  • Packaged as a pip-installable CLI tool
  • Clean project structure with proper metadata

Installation

For Users

pip install caesar-cipher-cli

As a Library

from caesar_cipher import caesar
print(caesar("hello", 3)) # Encryption...
print(caesar("khoor", 3,encrypt=False))  # Decryption...

For Developers to contribute

git clone https://github.com/Santhosh2949/caesar-cipher-cli
cd caesar-cipher-cli
pip install .

Usage

After installation, use the caesar command directly from the terminal.

Encrypt text caesar --text "hello" --shift 3

Output:

khoor

Decrypt text caesar --text "khoor" --shift 3 --decrypt

Output:

hello

Command Options

caesar --help

Available options:

--text              : Text to encrypt or decrypt

--shift             : Shift value for the cipher

--decrypt           : Enable decryption mode

Project Structure

caesar-cipher-cli/
├── caesar_cipher/
│   ├── __init__.py
│   ├── core.py
│   └── cli.py
├── tests/
│   └── test_core.py
├── pyproject.toml
├── CHANGELOG.md
├── README.md
└── LICENSE

Technologies Used

Python 3

argparse (standard library)

Git & GitHub

Python packaging (pyproject.toml)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caesar_cipher_cli-0.1.2.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

caesar_cipher_cli-0.1.2-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file caesar_cipher_cli-0.1.2.tar.gz.

File metadata

  • Download URL: caesar_cipher_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for caesar_cipher_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c0fda19e9e8c96adf9a5a6daf2ac5f18e59f1c6702c68eaf9021d79d299bc6a9
MD5 2fd1410922c894403f6f48e2abe5d716
BLAKE2b-256 c7847abb7cdcc0535d1a33bbba9f2d87d6876a5fcb35cbe4ad7dc4ee1a713a8f

See more details on using hashes here.

File details

Details for the file caesar_cipher_cli-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for caesar_cipher_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aa81950cc5bf85ba67ff5a54e8d80035c19310a558025402c8873dff7430ffd9
MD5 a29d1e4d6ce357af5ca3e77762265b50
BLAKE2b-256 6cad2af66d26ead2c629e24aedc4237d0457d9c8f3206d3d12584b57062cc2ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page